Polished up documentation

This commit is contained in:
Cian Hughes
2023-11-07 13:43:26 +00:00
parent 4c59e9a607
commit e0e23c7b9b
16 changed files with 356 additions and 9 deletions

View File

@@ -1,8 +1,30 @@
site_name: I-Form Server Node Deployer
theme: readthedocs
repo_url: https://github.com/Cian-H/I-Form_Server_Node_Deployer
repo_name: Cian-H/I-Form_Server_Node_Deployer
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site
theme:
name: material
logo: assets/logo.png
favicon: assets/favicon.ico
icon:
repo: fontawesome/brands/github-alt
palette:
# Palette toggle for light mode
- scheme: default
accent: teal
toggle:
icon: material/lightbulb
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
accent: teal
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
nav:
- Home: index.md
- Getting Started:
@@ -12,19 +34,34 @@ nav:
- Commands: commands.md
- Configuration: configuration.md
- Deployment: deployment.md
- Developer:
- autoignition: src/autoignition.md
- cli: src/cli.md
- config: src/config.md
- create_img: src/create_img.md
- create_disk: src/create_disk.md
- debug: src/debug.md
- utils: src/utils.md
- Reference:
- Documentation:
- autoignition: src/autoignition.md
- create_img: src/create_img.md
- create_disk: src/create_disk.md
# - FAQ: faq.md
# - Troubleshooting: troubleshooting.md
# - Changelog: changelog.md
# - License: license.md
- License: license.md
extra:
version:
provider: mike
# markdown_extensions:
# - mkdocs-typer
plugins:
#TODO: Add plugins, they seem to be broken at the moment
# - material/optimize
# - material/privacy
# - material/projects
# - material/typeset
- search
- mkdocstrings
- mkdocstrings
- git-revision-date-localized:
enable_creation_date: true