.github/workflows/main.yml

# This is a basic workflow to help you get started with Actions

name: Docs

# Controls when the workflow will run
on: 
  push:
     branches: [ main ]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v3
      - uses: actions/[email protected]
      - name: Install Mkdocs
        run: pip install mkdocs mkdocs-material

      - name: Build docs
        run: mkdocs build
        
      - name: GitHub Pages
        uses: crazy-max/[email protected]
        with:
          # Git domain (default github.com)
          # Git branch where assets will be deployed
          target_branch: gh-pages
          keep_history: true
          build_dir: site
        
      
        
        
1	# This is a basic workflow to help you get started with Actions
2
3	name: Docs
4
5	# Controls when the workflow will run
6	on:
7	push:
8	branches: [ main ]
9
10	# A workflow run is made up of one or more jobs that can run sequentially or in parallel
11	jobs:
12	# This workflow contains a single job called "build"
13	build:
14	# The type of runner that the job will run on
15	runs-on: ubuntu-latest
16
17	# Steps represent a sequence of tasks that will be executed as part of the job
18	steps:
19	# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
20	- uses: actions/checkout@v3
21	- uses: actions/[email protected]
22	- name: Install Mkdocs
23	run: pip install mkdocs mkdocs-material
24
25	- name: Build docs
26	run: mkdocs build
27
28	- name: GitHub Pages
29	uses: crazy-max/[email protected]
30	with:
31	# Git domain (default github.com)
32	# Git branch where assets will be deployed
33	target_branch: gh-pages
34	keep_history: true
35	build_dir: site
36
37
38
39