natrix/mkdocs.yml at main · AlbertoCentonze/natrix · 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
site_name: Natrix
strict: true
repo_url: https://github.com/AlbertoCentonze/natrix
repo_name: AlbertoCentonze/natrix
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      primary: teal
      accent: purple
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: teal
      accent: lime

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home:
    - Welcome To Natrix: index.md
    - Quick Start: quick-start.md
    - Configuration: configuration.md
    - Metadata Limitations: metadata-limitations.md
  - Rules:
    - Overview: rules/index.md
    - Memory Expansion (NTX1): rules/memory-expansion.md
    - Constant Naming Convention (NTX2): rules/constant-naming.md
    - Implicit Internal (NTX3): rules/implicit-internal.md
    - Implicit View (NTX4): rules/implicit-view.md
    - Implicit Pure (NTX5): rules/implicit-pure.md
    - Print Left (NTX6): rules/print-left.md
    - Cache Storage Variable (NTX7): rules/storage-caching.md
    - Unused Variable (NTX8): rules/unused-variable.md
    - Implicit Export (NTX9): rules/implicit-export.md
    - Unused Argument (NTX10): rules/unused-argument.md
    - Argument Naming Convention (NTX11): rules/argument-naming.md
    - Modifiers Ordering (NTX12): rules/modifiers-ordering.md
    - Unused Event (NTX13): rules/unused-event.md
    - Unused Imports (NTX14): rules/unused-imports.md
  - API Reference: api/index.md
  - Development: development/index.md