mdlint/mkdocs.yml at main · mprpic/mdlint · 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
site_name: mdlint
repo_url: https://github.com/mprpic/mdlint

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mprpic/mdlint

theme:
  name: material
  language: en
  favicon: assets/favicon.png
  logo: assets/icon.svg
  font:
    text: Ubuntu
    code: Ubuntu Mono
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - search.suggest
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.indexes
    - content.code.copy

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - toc:
      permalink: true

plugins:
  - search

hooks:
  - docs/hooks.py

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - assets/playground.js

docs_dir: docs

watch:
  - src/mdlint/rules

nav:
  - Overview: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Configuration: configuration.md
  - Playground: playground.md
  - Rules:
      - rules/index.md
      - rules/md001.md
      - rules/md003.md
      - rules/md004.md
      - rules/md005.md
      - rules/md007.md
      - rules/md009.md
      - rules/md010.md
      - rules/md011.md
      - rules/md012.md
      - rules/md013.md
      - rules/md014.md
      - rules/md018.md
      - rules/md019.md
      - rules/md020.md
      - rules/md021.md
      - rules/md022.md
      - rules/md023.md
      - rules/md024.md
      - rules/md025.md
      - rules/md026.md
      - rules/md027.md
      - rules/md028.md
      - rules/md029.md
      - rules/md030.md
      - rules/md031.md
      - rules/md032.md
      - rules/md033.md
      - rules/md034.md
      - rules/md035.md
      - rules/md036.md
      - rules/md037.md
      - rules/md038.md
      - rules/md039.md
      - rules/md040.md
      - rules/md041.md
      - rules/md042.md
      - rules/md043.md
      - rules/md044.md
      - rules/md045.md
      - rules/md046.md
      - rules/md047.md
      - rules/md048.md
      - rules/md049.md
      - rules/md050.md
      - rules/md051.md
      - rules/md052.md
      - rules/md053.md
      - rules/md054.md
      - rules/md055.md
      - rules/md056.md
      - rules/md058.md
      - rules/md059.md
      - rules/md060.md