forked from MichaIng/DietPi-Docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
180 lines (170 loc) · 7.18 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
site_name: DietPi.com Docs
site_url: https://dietpi.com/docs/
site_description: Official documentation pages for DietPi OS
site_author: DietPi.com Team
copyright: Copyright © 2021 DietPi.com | Documentation Distributed under <a target="_blank"
href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener">CC BY-SA 4.0</a>
repo_name: DietPi-Docs
repo_url: https://github.com/MichaIng/DietPi-Docs
edit_uri: edit/dev/docs/
docs_dir: docs
theme:
name: material
custom_dir: overrides # https://www.mkdocs.org/user-guide/styling-your-docs/#using-the-theme-custom_dir
font: false # Don't load fonts from Google
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
language: en
features:
- navigation.tabs
- navigation.top
- content.action.edit
- content.action.view
#logo: assets/images/logo.png
favicon: https://dietpi.com/favicon.ico
markdown_extensions:
- markdown.extensions.admonition # Highlighted warning/info blocks
- markdown.extensions.attr_list # Set custom HTML attributes {: }
- markdown.extensions.footnotes # Footnotes [^1]
- markdown.extensions.meta # Define meta data (page title and description) at the top of the Markdown document
- markdown.extensions.smarty # Automatically convert dashes, underscore, three-dots and quotes to text symbols
- markdown.extensions.tables # Tables
- markdown.extensions.toc: # Add HTML id attribute to headers
permalink: true # Headers are links to themselves
- pymdownx.betterem: # More intuitive emphasis handling
smart_enable: all # Even smarter for both (asterisk and underscore) syntax => GitHub-like
- pymdownx.details # Collapsible details blocks
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.keys # Keyboard key symbols
- pymdownx.magiclink: # Auto-links non angle bracket URLs and email addresses and allows to shorten and visualise Git repo links
repo_url_shortener: true
repo_url_shorthand: true
- pymdownx.superfences # Indented code blocks, e.g. within lists, admonition, details or tabbed blocks, implies pymdownx.highlight
- pymdownx.tabbed: # Tabbed content blocks
alternate_style: true
# Markdown extensions which could be used in the future
#
#- markdown.extensions.abbr # Abbreviations <abbr>
#- markdown.extensions.def_list # Definition lists
#- markdown.markdown.md_in_html # Allow Markdown syntax inside of HTML tags
#- pymdownx.arithmatex # LaTeX math term support
#- pymdownx.caret # Superscript <sup> and insert <ins> via caret ^
#- pymdownx.critic # Comment, highlight, add or strikethrough text
#- pymdownx.highlight # Configure code highlighting for all code definitions, fenced, inline and blocked by indentation, implied by pymdownx.superfences
#- pymdownx.inlinehilite # Highlight syntax in inline code
#- pymdownx.mark # Mark text <mark> via ==text==
#- pymdownx.smartsymbols # Easy symbols syntax (trademark, copyright, arrows, ...)
#- pymdownx.snippets # Insert Markdown files into others
#- pymdownx.tilde # Subscript <sub> and strikethrough <del> text via tilde ~
plugins:
- search
- minify:
minify_html: true
htmlmin_opts:
# https://htmlmin.readthedocs.io/en/latest/reference.html#main-functions
remove_comments: true
remove_all_empty_space: true
reduce_boolean_attributes: true
remove_optional_attribute_quotes: true
convert_charrefs: true
minify_css: true
css_files:
- assets/stylesheets/custom.css
#minify_js: true
#js_files:
#- assets/javascripts/custom.js
cache_safe: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/MichaIng/DietPi
- icon: fontawesome/solid/house
link: https://dietpi.com/
- icon: fontawesome/brands/twitter
link: https://twitter.com/DietPi_
extra_css:
- assets/stylesheets/custom.css
nav:
- HOME:
- Overview: index.md
- Installation: install.md
- Getting started: getting_started.md
- Software options: software.md
- DietPi tools: dietpi_tools.md
- Usage hints / HowTo: usage.md
- Supported hardware: hardware.md
- Releases: releases.md
- References: references.md
- OPTIMISED SOFTWARE:
- Overview: software.md
- Advanced Networking: software/advanced_networking.md
- BitTorrent & Download Tools: software/bittorrent.md
- Camera & Surveillance: software/camera.md
- Cloud & Backup Systems: software/cloud.md
- Databases & Data Stores: software/databases.md
- Desktops & Utilities: software/desktop.md
- Development & Programming: software/programming.md
- Distributed Projects: software/distributed_projects.md
- DNS Servers: software/dns_servers.md
- File Servers: software/file_servers.md
- Gaming & Emulation: software/gaming.md
- Hardware Projects: software/hardware_projects.md
- Home Automation: software/home_automation.md
- Logging Systems: software/log_system.md
- Media Systems: software/media.md
- Printing Servers: software/printing.md
- Remote Desktop & Remote Access: software/remote_desktop.md
- Social & Search: software/social.md
- SSH Servers: software/ssh.md
- System Security: software/system_security.md
- System Stats & Management: software/system_stats.md
- VPN: software/vpn.md
- Web Development: software/webserver_stack.md
- RELEASES:
- Overview: releases.md
- v8.13 January 2023: releases/v8_13.md
- v8.12 December 2022: releases/v8_12.md
- v8.11 November 2022: releases/v8_11.md
- v8.10 October 2022: releases/v8_10.md
- v8.9 September 2022: releases/v8_9.md
- v8.8 August 2022: releases/v8_8.md
- v8.7 July 2022, vol 2: releases/v8_7.md
- v8.6 July 2022: releases/v8_6.md
- v8.5 May 2022: releases/v8_5.md
- v8.4 April 2022, vol 2: releases/v8_4.md
- v8.3 April 2022: releases/v8_3.md
- v8.2 March 2022: releases/v8_2.md
- v8.1 February 2022: releases/v8_1.md
- v8.0 January 2022: releases/v8_0.md
- v7.9 December 2021: releases/v7_9.md
- v7.8 November 2021: releases/v7_8.md
- v7.7 October 2021: releases/v7_7.md
- v7.6 September 2021: releases/v7_6.md
- v7.5 August 2021: releases/v7_5.md
- v7.4 July 2021: releases/v7_4.md
- v7.3 June 2021: releases/v7_3.md
- v7.2 May 2021: releases/v7_2.md
- v7.1 April 2021: releases/v7_1.md
- v7.0 February 2021: releases/v7_0.md
- v6.34 December 2020: releases/v6_34.md
- v6.33 October 2020: releases/v6_33.md
- v6.32 August 2020: releases/v6_32.md
- v6.31 July 2020: releases/v6_31.md
- v6.30 May 2020: releases/v6_30.md
- v6.29 May 2020: releases/v6_29.md
- v6.28 January 2020: releases/v6_28.md
- v6.27 January 2020: releases/v6_27.md
- Earlier: https://dietpi.com/forum/c/version-history/6
- COMMUNITY:
# The first entry is opened when selecting "COMMUNITY" from primary navigation bar, hence should be an internal docs page.
- Social media: socialmedia.md
- DietPi GitHub page: https://github.com/MichaIng/DietPi
- DietPi Blog page: https://dietpi.com/blog/
- Report issues: https://github.com/MichaIng/DietPi/issues
- Request features: https://github.com/MichaIng/DietPi/issues/new/choose
- DietPi Forum: https://dietpi.com/forum/
- Community tutorials: https://dietpi.com/forum/c/community-tutorials/8
- Troubleshooting: https://dietpi.com/forum/c/troubleshooting/10