AlgoTree/mkdocs.yml at master · queelius/AlgoTree · 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
site_name: AlgoTree
site_description: A powerful, modern tree manipulation library for Python
site_author: Alexander Towell
site_url: https://queelius.github.io/AlgoTree/

repo_name: queelius/AlgoTree
repo_url: https://github.com/queelius/AlgoTree

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Introduction: getting-started/introduction.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Node API: guide/node.md
    - Tree API: guide/tree.md
    - Selectors: guide/selectors.md
    - Transformers: guide/transformers.md
    - Builders: guide/builders.md
    - DSL Parsing: guide/dsl.md
    - Export & Visualization: guide/export.md
  - Interoperability:
    - AlgoGraph: interop/algograph.md
  - API Reference:
    - Overview: api/index.md
    - Node: api/node.md
    - Tree: api/tree.md
    - Selectors: api/selectors.md
    - Transformers: api/transformers.md
  - Migration:
    - v1.x to v2.0: migration/v1-to-v2.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/queelius/AlgoTree