Merge pull request #35 from shenxianpeng/mkdocs

Update Mkdocs

Author: shenxianpeng

.github/workflows/mkdocs-deploy.yml

@@ -0,0 +1,22 @@
+name: MkDocs Deploy
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install -r docs/requirements.txt
+      - run: |
+          git config user.name 'github-actions'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          mkdocs gh-deploy --force

docs/README.md

@@ -1,4 +1,5 @@
 ## How to build the docs
+
 From the root directory of the repository, do the following to steps
 
 1. Install docs' dependencies

docs/index.md

@@ -21,6 +21,3 @@
    start="<!--footer-start-->"
    end="<!--footer-end-->"
 %}
-{%
-   include-markdown "README.md"
-%}

mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: C/C++ Linter Action's Docs
+site_name: C/C++ Linter Action
 site_description: "Developer documentation from sources."
 site_url: "https://shenxianpeng.github.io/cpp-linter-action"
 repo_url: "https://github.com/shenxianpeng/cpp-linter-action"