injinja/mkdocs.yml at main · neozenith/injinja · 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: Injinja Documentation
site_description: "Injinja: Injectable Jinja Configuration tool. Insanely configurable... config system."
site_url: https://neozenith.github.io/injinja/
site_author: Josh Peak
repo_url: https://github.com/neozenith/injinja
repo_name: neozenith/injinja
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
    - toc.integrate
  icon:
    logo: material/ninja
  favicon:  🥷
  palette:
    - scheme: default
      primary: deep orange
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: brown
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            find_stubs_package: true
            backlinks: tree
            allow_inspection: true
            docstring_style: google
            members_order: source
            show_root_heading: true
            show_source: true
            show_bases: false
            heading_level: 2
            show_inheritance_diagram: true
            inheritance_diagram_direction: TD
            separate_signature: true
            show_signature_annotations: true
            show_signature_type_parameters: true


nav:
  - Home: index.md
  - User Guide:
    - Installation: user-guide/installation.md
    - Quick Start: user-guide/quick-start.md
    - Configuration: user-guide/configuration.md
    - Schema Validation: user-guide/schema-validation.md
    - Advanced Usage: user-guide/advanced.md
  - API Reference:
    - Core Module: api/injinja.md
  - Architecture:
    - Overview: architecture/overview.md
    - Diagrams: architecture/diagrams.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/neozenith/injinja
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/injinja/

extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js