wiwik/mkdocs.yml at master · dsoftwareinc/wiwik · 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
140
---
nav:
  - 'index.md'
  - 'Features':
      - 'Features': 'features/index.md'
      - 'features/search.md'
      - 'features/invitation.md'
      - 'features/slack.md'
      - 'features/similarity.md'
      - 'features/oauth.md'
      - 'features/badges.md'
  - 'Project structure':
      - 'Architecture': 'arch/index.md'
      - 'wiwik_lib': 'arch/wiwik_lib.md'
      - 'userauth': 'arch/userauth.md'
      - 'badges': 'arch/badges.md'
      - 'tags': 'arch/tags.md'
      - 'spaces': 'arch/spaces.md'
      - 'forum': 'arch/forum.md'
      - 'articles': 'arch/articles.md'
      - 'similarity': 'arch/similarity.md'
  - 'Deployment guide':
      - 'Deployment guide': 'deployment/index.md'
      - 'Configuration': 'deployment/configuration.md'
      - 'Local Development guide': 'deployment/local-dev.md'

  - 'Contributing':
      - 'Contributing': 'contributing/index.md'
      - 'Code of conduct': 'contributing/CODE_OF_CONDUCT.md'
  - 'Frequently asked questions': 'faq.md'
  - 'Insiders': 'wiwik-insiders.md'

site_name: What I Wish I Knew (wiwik)
site_author: Daniel Moran
site_description: >-
  Documentation for wiwik knowledge management system
# Repository
repo_name: cunla/wiwik
repo_url: https://github.com/dsoftwareinc/wiwik

# Copyright
copyright: Copyright &copy; 2022 - 2023 Daniel Moran

extra_css:
  - stylesheets/extra.css

extra:
  generator: false
  version:
    provider: mike
#  analytics:
#    provider: google
#    property: G-GJBJBKXT19

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    # - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    # - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    # - navigation.prune
    - navigation.sections
    # - navigation.tabs.sticky
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  highlightjs: true
  hljs_languages:
    - yaml
    - django

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: dsoftwareinc
      repo: wiwik
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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
  - toc:
      permalink: true
      toc_depth: 3