manta/mkdocs.yml

78 lines
2.0 KiB
YAML
Raw Normal View History

2023-08-15 08:33:50 +02:00
site_name: "Manta Documentation"
2023-03-09 22:35:16 +01:00
site_description: Manta Documentation
site_author: Fischer Moseley
repo_url: https://github.com/fischermoseley/manta/
2023-03-09 22:40:11 +01:00
docs_dir: 'doc'
2023-03-09 22:37:41 +01:00
2023-03-09 22:26:45 +01:00
theme:
2023-03-09 22:35:16 +01:00
name: material
2023-09-02 18:54:20 +02:00
logo: assets/logo_minimal_border.png
favicon: assets/logo_ray_only_with_shadow.png
2023-03-10 03:17:39 +01:00
features:
- content.code.copy
- content.code.annotate
2023-04-13 03:32:34 +02:00
- navigation.sections
- navigation.expand
2023-03-10 03:17:39 +01:00
2023-03-09 23:22:19 +01:00
palette:
2024-02-10 07:49:58 +01:00
- media: "(prefers-color-scheme)"
2023-03-09 23:22:19 +01:00
toggle:
2024-02-10 07:49:58 +01:00
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: custom
toggle:
icon: material/toggle-switch
2023-03-09 23:22:19 +01:00
name: Switch to dark mode
2024-02-10 07:49:58 +01:00
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: custom
2023-03-09 23:22:19 +01:00
toggle:
2024-02-10 07:49:58 +01:00
icon: material/toggle-switch-off
name: Switch to system preference
2023-03-09 22:35:16 +01:00
2023-03-10 05:31:05 +01:00
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
2023-03-10 03:17:39 +01:00
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.arithmatex:
generic: true
2023-03-10 03:17:39 +01:00
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
2023-03-10 05:56:16 +01:00
- admonition
- pymdownx.details
- pymdownx.superfences
2023-08-16 08:07:59 +02:00
- pymdownx.tilde
2023-09-02 18:29:26 +02:00
- attr_list
2023-03-10 03:17:39 +01:00
2023-03-09 22:35:16 +01:00
nav:
2023-08-02 16:39:07 +02:00
- Home: index.md
- Installation: installation.md
- Getting Started: getting_started.md
- Alternatives: alternatives.md
- Architecture: architecture.md
- Usage:
2023-08-02 16:39:07 +02:00
- IO Core: io_core.md
2023-09-02 18:33:42 +02:00
- Logic Analyzer Core: logic_analyzer_core.md
2024-01-06 08:01:57 +01:00
- Memory Core: memory_core.md
- UART Interface: uart_interface.md
- Ethernet Interface: ethernet_interface.md
- For Developers:
- Repository Structure: repository_structure.md
- Roadmap: https://github.com/fischermoseley/manta/milestones