docs: Add exception for mkdocs 📚

This commit is contained in:
Dheepak Krishnamurthy 2021-11-27 12:51:15 -07:00
parent c206b142ef
commit d5d37ee35c
2 changed files with 13 additions and 9 deletions

View file

@ -14,13 +14,14 @@ jobs:
- name: Setup Python - name: Setup Python
uses: actions/setup-python@v1 uses: actions/setup-python@v1
with: with:
python-version: '3.8' python-version: "3.8"
architecture: 'x64' architecture: "x64"
- name: Install dependencies - name: Install dependencies
run: | run: |
python3 -m pip install --upgrade pip # install pip python3 -m pip install --upgrade pip # install pip
python3 -m pip install mkdocs # install mkdocs python3 -m pip install mkdocs # install mkdocs
python3 -m pip install mkdocs-material # install material theme python3 -m pip install mkdocs-material # install material theme
python3 -m pip install mkdocs-exclude # install mkdocs exclude
python3 -m pip install pygments pymdown-extensions mkdocs-material-extensions termcolor mkdocs-material mkdocs-macros-plugin python3 -m pip install pygments pymdown-extensions mkdocs-material-extensions termcolor mkdocs-material mkdocs-macros-plugin
- name: Copy README - name: Copy README
run: | run: |

View file

@ -19,6 +19,9 @@ markdown_extensions:
# Plugins # Plugins
plugins: plugins:
- search - search
- exclude:
glob:
- "*.1"
# Theme # Theme
theme: theme:
@ -42,12 +45,12 @@ extra:
nav: nav:
- Home: index.md - Home: index.md
- Getting Started: - Getting Started:
- Installation: installation.md - Installation: installation.md
- Quick Start: quick_start.md - Quick Start: quick_start.md
- Keybindings: keybindings.md - Keybindings: keybindings.md
- Configuration: - Configuration:
- Key configuration: configuration/keys.md - Key configuration: configuration/keys.md
- Color configuration: configuration/colors.md - Color configuration: configuration/colors.md
- Advanced: configuration/advanced.md - Advanced: configuration/advanced.md
- Developer Guide: - Developer Guide:
- Guide: developer/guide.md - Guide: developer/guide.md