choreographer/mkdocs.yml at main · plotly/choreographer · 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
---
### Site metadata ###

site_name: choreographer
repo_name: github


### Build settings ###

docs_dir: 'docs/'
nav:
  - Readme: >-
      {
        "dest": "README.md",
        "src": "../README.md",
        "replace": {"src='docs/": "src='"}
      }
  - User API: >-
        {
          "api": "choreographer",
          "test": ["exports", "_prefix_local"],
          "tree": "none"
        }
  - Developer API:
      - >-
        {
          "api": "choreographer",
          "test": ["exports", "_prefix_local"],
          "tree": "packages"
        }
  # CLI tools?

theme:
  name: material
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
plugins:
  - quimeta
  - quicopy
  - quiapi