forked from AgonConsole8/agon-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
105 lines (99 loc) · 2.91 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# To view the documentation locally on your machine, use the following steps
#
# Clone the GitHub agon-docs repo locally, then on the command line:
#
# cd /github/agon-docs
# python -m venv venv
# source venv/bin/activate
# pip install mkdocs-material
# mkdocs new .
# mkdocs serve
#
# The last command should eventually print something like
# Serving on http://127.0.0.1:8000/
# and you can open that URL in a local brower. If you are locally editing
# the documentation, leave the server process running and the browser
# pages will auto-reload as you save edits.
#
site_name: "Community Agon Platform documentation"
repo_url: https://github.com/AgonConsole8/agon-docs
repo_name: contribute
edit_uri: edit/main/docs/
theme:
favicon: assets/favicon.png
logo: assets/logo.png
name: material
features:
- navigation.sections
- navigation.expand
- navigation.instant
- navigation.instant.preview
- navigation.top
- search.suggest
- search.highlight
- content.tabs.link
- content.code.annotate
- content.code.annotation
- content.code.copy
- content.footnote.tooltips
- content.action.edit
language: en
palette:
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
primary: deep purple
accent: purple
- scheme: slate
toggle:
icon: material/toggle-switch
name: switch to light mode
primary: deep purple
accent: lime
extra_css:
- stylesheets/extra.css
nav:
- 'Welcome & getting started':
- 'Start here': index.md
- 'FAQ': FAQ.md
- 'Theory of operation': Theory-of-operation.md
- 'MOS':
- 'Command line': MOS.md
- 'API': MOS-API.md
- 'VDP':
- 'Overview': VDP.md
- 'Main Commands': vdp/VDU-Commands.md
- 'Screen Modes': vdp/Screen-Modes.md
- 'PLOT Commands': vdp/PLOT-Commands.md
- 'System Commands': vdp/System-Commands.md
- 'Audio API': vdp/Enhanced-Audio-API.md
- 'Bitmaps and Sprites API': vdp/Bitmaps-API.md
- 'Buffered Commands API': vdp/Buffered-Commands-API.md
- 'Context Management API': vdp/Context-Management-API.md
- 'Font Management API': vdp/Font-API.md
- 'BBC Basic': BBC-BASIC-for-Agon.md
- 'GPIO': GPIO.md
- 'Guides':
- 'Updating Firmware': Updating-Firmware-from103.md
- 'Updating Firmware (prio v1.03)': Updating-Firmware.md
- 'Additional resources':
- 'External documentation': External-Documentation.md
- 'Third party projects': Third-Party-Projects.md
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.arithmatex:
generic: true
- footnotes
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.mark
- attr_list