krait/mkdocs.yml at master · osxbit/krait · 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
site_name: K R A I T
repo_url: https://github.com/osxbit/krait/
repo_name: osxbit/krait
edit_uri: tree/master/docs/

extra:
  generator: false # no footer with "made with mkdocs"

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - markdown.extensions.attr_list
  - md_in_html
  - meta
  - pymdownx.details
  - pymdownx.highlight:
      default_lang: python
      anchor_linenums: true
      pygments_lang_class: true
      linenums_style: table
      stripnl: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.progressbar
  - pymdownx.snippets
  - pymdownx.striphtml
  - pymdownx.superfences
  - pymdownx.tasklist
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    logo: material/cube-send
  font:
    text: Fira Sans
    code: Fira Code
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer # add next/previous nav btn on footer
    - navigation.instant
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate # Table of contents not on right side

  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-3
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

exclude_docs: |
  .* # exclude all dot-files (and directories)

extra_css:
  - assets/stylesheets/extra.css

plugins:
  - awesome-pages
  - git-authors
  - git-revision-date-localized
  - mkdocstrings:
      handlers:
        python:
          options:
            show_docstring_examples: true
            docstring_style: numpy

  - kroki:
      FencePrefix: ""
      FileTypes: [png, svg]
  - literate-nav:
      nav_file: nav.md
  - offline
  - search
  - section-index