docs/mkdocs.yml at master · PapyrusReader/docs · GitHub

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
site_name: Papyrus Documentation
site_description: Cross-platform e-book management application
site_author: Papyrus
site_url: https://papyrusreader.github.io/docs/
repo_name: Papyrus
repo_url: https://github.com/PapyrusReader/client
edit_uri: edit/master/src/
docs_dir: src
site_dir: site

theme:
  name: material
  language: en

  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow

  icon:
    repo: fontawesome/brands/github

  font:
    text: Inter
    code: JetBrains Mono

plugins:
  - search:
      separator: '[\s\-\.]+'

exclude_docs: |
  SUMMARY.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: README.md

  - Analysis:
      - Market analysis: market-analysis.md

  - Requirements:
      - Overview: requirements/README.md
      - Functional requirements: requirements/functional-requirements.md
      - Non-functional requirements: requirements/non-functional-requirements.md

  - System design:
      - Actors: actors.md
      - Use cases: use-cases.md
      - Entities: entities.md
      - Database model: database-model.md
      - Server architecture: server-architecture.md

  - Implementation:
      - Technologies: technologies.md
      - User interface: user-interface.md

  - API:
      - Overview: api/index.md

  - Reference:
      - External resources: external/index.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Eoic/Papyrus

  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/panzoom@9.4.3/dist/panzoom.min.js
  - javascripts/extra.js