forked from Valastiri/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
85 lines (78 loc) · 2.42 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
# Project Information
site_name: FlyByWire Simulations Guides
site_url: https://docs.flybywiresim.com
# repo allows for linking main repo to docs
# Uncomment to use
repo_url: https://github.com/flybywiresim/a32nx/
repo_name: flybywiresim/a32nx
edit_uri: "" #removes edit button and icon
# Navigation
# Section Containers are defined by `- Section Name:`
# These should have NO filename.md next to them
# Nestle all pages under neath sections as seen below:
nav:
- Home: index.md
- Getting Started:
- Installation: start/installation.md
- Starting the plane: start/first-steps.md
- Common Questions: start/faq.md
- SDK Overview:
- Docker & Building: sdk/docker.md
- HTML/JS Gauges: sdk/html-gauges.md
- WASM Gauges: sdk/wasm-gauges.md
- XML & RNP: sdk/xml-rnp.md
- Sounds: sdk/sounds.md
- Modeling: sdk/modeling.md
- Texturing: sdk/texturing.md
- Common Development:
- Blender Plugin: common-dev/blender.md
- EFB: common-dev/efb.md
- Installer: common-dev/installer.md
- Rust SDK: common-dev/msfs-rs.md
- Web API: common-dev/web-api.md
- A32NX Development:
- Overview: a32nx-dev/overview.md
- HTML/JS Code: a32nx-dev/html.md
- Local SimVars: a32nx-dev/simvars.md
- XML ModelBehaviors: a32nx-dev/xml.md
- React Overhaul: a32nx-dev/react.md
- Donate: donate.md
# Configuration
theme:
name: material
# Theme Overhaul configruation. Use with caution.
# Uncomment custom_dir requires additional setup.
#custom_dir: overrides
logo: assets/images/FBW-Square-White.png
palette:
scheme: slate
features:
- navigation.tabs
- navigation.instant
- toc.integrate
favicon: assets/images/FBW-tail.png
# Plugins
plugins:
- search
- git-revision-date-localized:
type: date
# Styling Front-end
extra_css:
- stylesheets/extra.css
# Extra Functions / Customizations
extra:
generator: false
social:
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/FlyByWireSimulations/
name: FlyByWire Simulations on Facebook
# Additional Markdown Extensions to use bundled icon sets
markdown_extensions:
- admonition # Makes things pretty
- pymdownx.superfences # Nestled code
- attr_list
- pymdownx.tabbed #content tabs
- pymdownx.details # Additional features to admonition
- pymdownx.emoji: #Allows emjoy style inline embeds for icons
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg