/
mkdocs.yml
80 lines (80 loc) · 2.59 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
site_name: Status-Page Documentation
site_dir: statuspage/project-static/docs
site_url: https://docs.status-page.dev/
repo_name: status-page/status-page
repo_url: https://github.com/status-page/status-page
edit_uri: 'edit/main/docs/'
theme:
name: material
custom_dir: docs/_theme/
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/lightbulb
name: Switch to Light Mode
plugins:
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- import os
- import django
- os.chdir('statuspage/')
- os.environ.setdefault("DJANGO_SETTINGS_MODULE", "statuspage.settings")
- django.setup()
options:
heading_level: 3
members_order: source
show_root_heading: true
show_root_full_path: false
show_root_toc_entry: false
show_source: false
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/status-page/status-page
markdown_extensions:
- admonition
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
extra_css:
- extra.css
nav:
- Introduction: 'index.md'
- Installation:
- Install Status-Page: 'installation/index.md'
- 1. PostgreSQL: 'installation/1-postgresql.md'
- 2. Redis: 'installation/2-redis.md'
- 3. Status-Page: 'installation/3-status-page.md'
- 4. Gunicorn: 'installation/4-gunicorn.md'
- 5. HTTP Server: 'installation/5-http-server.md'
- Upgrading Status-Page: 'installation/upgrading.md'
- Configuration:
- Captcha: 'configuration/captcha.md'
- Important Notes:
- Captcha: 'important-notes/admin-panel.md'
- Release Notes:
- Overview: 'release-notes/index.md'
- Version 2.4: 'release-notes/version-2.4.md'
- Version 2.3: 'release-notes/version-2.3.md'
- Version 2.2: 'release-notes/version-2.2.md'
- Version 2.1: 'release-notes/version-2.1.md'
- Version 2.0: 'release-notes/version-2.0.md'