apkit/mkdocs.yml at main · fedi-libs/apkit · 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
site_name: apkit
site_url: https://apkit.fedi-libs.org
repo_url: https://github.com/fedi-libs/apkit
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Tutorial: tutorial.md
  - Guides:
    - Overview: guides/index.md
    - Configuration: guides/configuration.md
    - Client: guides/client.md
    - Server: guides/server.md
    - Outbox: guides/outbox.md
    - Models: guides/models.md
    - KV Store: guides/kv_store.md
    - Nodeinfo: guides/nodeinfo.md
    - Advanced:
      - Overview: guides/advanced/index.md
      - Framework Integration: guides/advanced/framework_integration.md
  - Resources:
    - Overview: resources/index.md
    - Contribution Guide: resources/contributing.md
    - Useful Links: resources/useful_links.md
    - Security Policy: resources/security.md
  - About: about.md

theme:
  name: material
  language: en
  palette:
    primary: red
    scheme: slate
    accent: purple
  features:
    - navigation.instant
    - navigation.tabs
    - tags
    - content.action.edit

plugins:
  - search

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde