Skip to content

Update index.md

Update index.md #6

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy GitHub Pages with MkDocs
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- uses: "actions/setup-python@v3"
with:
python-version: "3.10"
- name: Install MkDocs
run: "pip install mkdocs mkdocs-material"
- name: Build with MkDocs
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: "site/"
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1