Added initial documentation

This commit is contained in:
Cian Hughes
2023-11-10 16:48:42 +00:00
parent 24e0a5bb21
commit 2e6786389a
13 changed files with 103 additions and 8 deletions

View File

@@ -24,11 +24,15 @@ theme:
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
features:
- content.code.copy
nav:
- Home: index.md
- Getting Started:
- Usage: usage.md
- Accessing the server: getting_started/accessing_the_server.md
- Usage: getting_started/usage.md
- Deploying new nodes: getting_started/deploying_new_nodes.md
- Reference:
# - FAQ: faq.md
# - Troubleshooting: troubleshooting.md
@@ -39,6 +43,15 @@ extra:
version:
provider: mike
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
plugins:
#TODO: Add plugins, they seem to be broken at the moment
# - material/optimize
@@ -46,5 +59,6 @@ plugins:
# - material/projects
# - material/typeset
- search
# - git-revision-date-localized:
# enable_creation_date: true
- git-revision-date-localized:
enable_creation_date: true
- glightbox