mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-05-25 18:04:03 +00:00
Update documentation and configuration for MkDocs
- Added new pages to the documentation navigation, including Docker, Upgrade, and Guides sections. - Updated mkdocs.yml to include the mkdocs-exclude plugin for better content management. - Modified pyproject.toml to include mkdocs-exclude as a dependency. - Adjusted GitHub Actions workflow to install the new dependency. - Removed outdated link from the index.md documentation page.
This commit is contained in:
@@ -22,7 +22,7 @@ jobs:
|
||||
python-version: "3.x"
|
||||
|
||||
- name: Install MkDocs and Material
|
||||
run: pip install mkdocs-material
|
||||
run: pip install "mkdocs-material>=9.0.0,<10" "mkdocs-exclude>=1.0.0"
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
run: mkdocs gh-deploy --force
|
||||
|
||||
@@ -26,7 +26,6 @@ Documentation for the MeshCore bot: setup, configuration, commands, and services
|
||||
| [Repeater Commands](REPEATER_COMMANDS.md) | Repeater management DM commands |
|
||||
| [Feed Management](FEEDS.md) | RSS/REST feeds and posting to channels |
|
||||
| [Web Viewer](WEB_VIEWER.md) | Web-based data viewer and API |
|
||||
| [Documentation site setup](DOCS_SITE.md) | How to build and deploy this site |
|
||||
|
||||
## Service Plugins
|
||||
|
||||
|
||||
@@ -33,6 +33,9 @@ theme:
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- exclude:
|
||||
glob:
|
||||
- local/**
|
||||
|
||||
markdown_extensions:
|
||||
- pymdownx.superfences
|
||||
@@ -49,10 +52,14 @@ nav:
|
||||
- Getting Started: getting-started.md
|
||||
- FAQ: faq.md
|
||||
- Command Reference: COMMANDS.md
|
||||
- Docker: DOCKER.md
|
||||
- Configuration:
|
||||
- Overview: configuration.md
|
||||
- Path Command: PATH_COMMAND_CONFIG.md
|
||||
- Upgrade: UPGRADE.md
|
||||
- Web Viewer: WEB_VIEWER.md
|
||||
- Guides:
|
||||
- Repeater Commands: REPEATER_COMMANDS.md
|
||||
- Service Plugins:
|
||||
- Overview: service-plugins.md
|
||||
- Discord Bridge: DISCORD_BRIDGE.md
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@ dependencies = [
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
docs = ["mkdocs-material>=9.0.0"]
|
||||
docs = ["mkdocs-material>=9.0.0", "mkdocs-exclude>=1.0.0"]
|
||||
test = ["pytest>=7.0", "pytest-asyncio>=0.21"]
|
||||
|
||||
[project.scripts]
|
||||
|
||||
Reference in New Issue
Block a user