forked from AntonioMrtz/SpotifyElectron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
71 lines (67 loc) · 2.06 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
site_name: Spotify Electron Documentation
site_author: Antonio Martinez Fernandez
repo_url: https://github.com/AntonioMrtz/SpotifyElectron
site_description: Documentation for Spotify Electron, an open-source cross-platform music streaming app
remote_branch: gh-pages
nav:
- Home: index.md
- Vision: VISION.md
- How to contribute: CONTRIBUTING.md
- Git convention: Git-Convention.md
- Global Set up: SETUP.md
- Architecture: Architecture.md
- Authentication & Login: Auth-Login.md
- Backend:
- Set up: backend/SETUP.md
- Environment: backend/Environment.md
- File Structure: backend/File-Structure.md
- Cloud: backend/Cloud.md
- Docker: backend/Docker.md
- Linting & Formatting: backend/Linting-&-Formatting.md
- Testing: backend/Testing.md
- FAQ: backend/FAQ.md
- Frontend:
- Set up: frontend/SETUP.md
- File Structure: frontend/File-Structure.md
- Linting & Formatting: frontend/Linting-&-Formatting.md
- Testing: frontend/Testing.md
- Package app: frontend/Package-app.md
- FAQ: frontend/FAQ.md
- Utils:
- Release procedure: utils/Release-Procedure.md
- OpenAPI schema generation & usage: utils/OpenAPI.md
- Mkdocs development & usage: utils/Mkdocs.md
- Generate Mock data: utils/Generate-Mock-Data.md
- Testing principles: utils/Testing-Principles.md
- Code of conduct: CODE_OF_CONDUCT.md
- Contributors: CONTRIBUTORS.md
theme:
logo: assets/logo.png
name: material
features:
- navigation.indexes
palette:
- scheme: slate
primary: black
accent: blue
toggle:
icon: material/brightness-4
name: Switch to light mode
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
plugins:
- mkdocstrings
- search
markdown_extensions:
- mdx_truly_sane_lists
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences