-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
53 lines (46 loc) · 1.49 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
# See: https://github.com/mkdocs/mkdocs/blob/master/docs/user-guide/configuration.md
site_name: advection
site_description: django based web backend for AFrOST website
site_author: afrost-org
repo_url: https://github.com/afrost-org/advection
nav:
- Home: index.md
- API:
- 'Overview': api/0-overview.md
- 'Authentication': api/1-auth.md
- 'Current User': api/2-current-user.md
- 'Errors': api/errors.md
- Backend:
- 'Server Configurations': backend/server_config.md
- 'Coding Rules': backend/coding_rules.md
- Release Notes: release_notes.md
theme:
name: 'material'
feature:
tabs: true
copyright: ''
# directory to output HTML build
site_dir: _docs_html
# Determines if a broken link to a page within the documentation is considered
# a warning or an error (link to a page not listed in the pages setting). Set to
# true to halt processing when a broken link is found, false prints a warning.
strict: true
# Determines the address used when running mkdocs serve.
# Set it to 8001, so that it doesn't conflict with django's 8000 port
dev_addr: '127.0.0.1:8001'
markdown_extensions:
- markdown.extensions.meta
- markdown.extensions.admonition
- markdown.extensions.smarty
- markdown.extensions.sane_lists
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.toc:
permalink: true
- pymdownx.superfences:
preserve_tabs: true
- pymdownx.inlinehilite
- pymdownx.smartsymbols
- pymdownx.mark
- markdown_include.include:
base_path: docs