-
Notifications
You must be signed in to change notification settings - Fork 30
/
mkdocs.yml
215 lines (196 loc) · 7.61 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
site_name: MiSTer FPGA Documentation
site_url: https://mister-devel.github.io/MkDocs_MiSTer/
site_author: Kevin Coleman
site_description: >-
MiSTer FPGA is an open source project that aims to recreate various classic computers, game consoles, and arcade machines, using modern hardware.
copyright: Copyright © 2022-2024 MiSTer FPGA
repo_name: MkDocs_MiSTer
repo_url: https://github.com/MiSTer-devel/MkDocs_MiSTer/
edit_uri: edit/main/docs/
theme:
palette:
# Dark Mode
- scheme: MiSTer-Dark
toggle:
icon: material/brightness-4
name: Switch to Dark mode
# Light Mode
- scheme: MiSTer-Light
toggle:
icon: material/brightness-7
name: Switch to Light mode
name: material
favicon: assets/8-bit_mister_kun_fullcolor.svg
logo: assets/mister_kun_bw.svg
font:
text: Roboto
code: Source Code Pro
features:
# Highlight search terms when user searches for things
- search.highlight
# Offer most likely search result as a suggestion
- search.suggest
# Update url with the active anchor as highlighted in ToC
- navigation.tracking
# Enable Edit on Github Button (needed after version 9)
- content.action.edit
# Folder for css and page overrides
custom_dir: overrides
plugins:
# Explicitly call out search ahead of time, because if you use other plugins this has to be done.
- search:
# Only English for now
lang: en
# https://squidfunk.github.io/mkdocs-material/tutorials/social/basic/
- social
# mkdocs-rss-plugin
# https://MiSTer-devel.github.io/MkDocs_MiSTer/feed_rss_updated.xml
# https://MiSTer-devel.github.io/MkDocs_MiSTer/feed_rss_created.xml
- rss:
image: assets/mister_kun_bw.svg
# Permits the use of embedded videos
- ffc-mkdocs-video:
css_style:
width: 100%;
height: 100%;
# Adds date/time stamp to page when updated according to git history.
- git-revision-date-localized
# Makes things load faster at the cost of a little extra build time
- minify:
minify_html: true
# Customization
extra:
# Subject to change later when incorporated into the project, potentially https://docs.misterfpga.org/
homepage: https://MiSTer-devel.github.io/MkDocs_MiSTer/
# Placeholder for analytics configuration, modify values and uncomment when ready
# analytics:
# provider: google
# property: !ENV GOOGLE_ANALYTICS_KEY
social:
- icon: twitter
link: https://twitter.com/MiSTerFPGABot/
- icon: discord
link: https://discord.com/invite/misterfpga/
- icon: github
link: https://github.com/MiSTer-devel/
- icon: forum
link: https://misterfpga.org/
nav:
# Only the logo and brief summary of what the project is about
- Home: index.md
# Setup section is to remain very stable and simple
- First-time Setup:
- Requirements: setup/requirements.md
- Setup MicroSD Card: setup/software.md
- Running the Updater: setup/updater.md
- Define Your Gamepad: setup/controller.md
- Transferring Games: setup/games.md
- Play a Game: setup/play.md
# Just some basics things to go over. Slightly more advanced than the setup section above
- The Basics:
- FAQ: basics/faq.md
- Troubleshooting: basics/troubleshooting.md
- Game Saves: basics/saves.md
- Addon Boards: basics/addons.md
- Cases: basics/case.md
- Hotkeys: basics/hotkey.md
- Controllers: basics/input.md
- Keyboards: basics/keyboard.md
- WiFi: basics/wifi.md
- Bluetooth: basics/bluetooth.md
- Video Configuration: basics/video.md
- CD-based ROMs: basics/cd.md
- Links: basics/links.md
# General core information, not a full replacement for the core Readme's however
- Cores:
- What Is a Core: cores/what.md
# Just a good place to show off special features of some cores, to get people started.
- Common Core Features:
- Cheats: cores/features/cheats.md
- RTC Support: cores/features/rtcsupport.md
- Core Highlights:
- PSX: cores/highlights/psx.md
- SNES: cores/highlights/snes.md
- NES: cores/highlights/nes.md
- TurboGrafx-16: cores/highlights/tgfx16.md
- Genesis: cores/highlights/genesis.md
- MegaCD: cores/highlights/megacd.md
- Game Boy 2 Player: cores/highlights/gb2p.md
- Console Cores: cores/console.md
- Computer Cores: cores/computer.md
- Arcade Cores: cores/arcade.md
- Other Cores: cores/other.md
- Core Paths: cores/paths.md
# More advanced configuration options. Anything not basic or not simple essentials, dump here.
- Advanced Configuration:
- Video Modes: advanced/videomodes.md
- Video Scaling: advanced/videoscaling.md
- Add-On Boards:
- RTC Board: advanced/rtc.md
- Networking:
- Setting Up SSH, FTP, and NAS: advanced/network.md
- Computer Core Networking: advanced/computer.md
- CRT Displays:
- CRT Configuration Table: advanced/crttable.md
- Using Your CRT With MiSTer: advanced/crt.md
- Direct Video Adapter: advanced/directvideo.md
- Core Default Resolutions: advanced/nativeres.md
- Audio Filters: advanced/audio.md
- MIDI Features: advanced/midi.md
- Multi-Button Mapping: advanced/multibutton.md
- DIY 2-Player Arcade: advanced/diy2parcade.md
- INI Settings: advanced/ini.md
- Lag Explained: advanced/lag.md
- MGL Files: advanced/mgl.md
- Console Connection: advanced/console.md
# Developer reference. This is going to mostly mirror what is up on Github wiki already.
- Developer Reference:
- Compiling for MiSTer: developer/mistercompile.md
- Porting Cores: developer/porting.md
- Core Configuration String: developer/conf_str.md
- Top-level of Cores:
- overview of emu module: developer/emu.md
- sys - hps_io: developer/hps_io.md
- sys - video_freak: developer/video_freak.md
- sys - video_mixer: developer/video_mixer.md
- sys - arcade_video: developer/arcade_video.md
- Useful Snippets: developer/snippets.md
- Savestates: developer/savestates.md
- Core Names: developer/corenames.md
- MRA Setnames: developer/mrasetnames.md
- Arcade ROMS and MRA Files: developer/mra.md
- Debugging (USB Blaster): developer/debugging.md
- Core Components Where Used: developer/component.md
- Developer Journeys:
- Analog Simulation: developer/analogsim.md
- Head On Sound PCB Implementation: developer/headonsoundpcb.md
- Template Core: https://github.com/MiSTer-devel/Template_MiSTer
- Useful Links: developer/links.md
- Tips and Guidelines: developer/principles.md
# Fun guide that shows users how to edit the documentation site
- Editing These Docs: editing.md
markdown_extensions:
# https://facelessuser.github.io/pymdown-extensions/extensions/highlight/
- pymdownx.highlight:
anchor_linenums: true
# https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/
- pymdownx.inlinehilite
# https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
- pymdownx.snippets
# https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
- pymdownx.superfences
# https://facelessuser.github.io/pymdown-extensions/extensions/keys/
- pymdownx.keys:
camel_case: true
# https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# https://squidfunk.github.io/mkdocs-material/reference/images/
- attr_list
# https://python-markdown.github.io/extensions/md_in_html/
- md_in_html
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/extra.js