feat(mkdocs.yml): add mkdocs config and publish to gh pages #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Publish documentation | ||
on: | ||
push: | ||
branches: | ||
- master | ||
jobs: | ||
publish-documentation: | ||
Check failure on line 10 in .github/workflows/publish_docs.yml GitHub Actions / Publish documentationInvalid workflow file
|
||
runs-on: ubuntu-latest | ||
needs: update-cli-screenshots | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" | ||
fetch-depth: 0 | ||
- name: Pull latest changes | ||
run: | | ||
git pull origin master | ||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.x" | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install -U mkdocs mkdocs-material | ||
- name: Build docs | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
python -m mkdocs build | ||
- name: Push doc to Github Page | ||
uses: peaceiris/actions-gh-pages@v4 | ||
with: | ||
personal_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} | ||
publish_branch: gh-pages | ||
publish_dir: ./site | ||
user_name: "github-actions[bot]" | ||
user_email: "github-actions[bot]@users.noreply.github.com" |