cdl-parser/mkdocs.yml at main · gemmology-dev/cdl-parser · 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
site_name: CDL Parser
site_description: Crystal Description Language parser for crystallographic visualization
site_url: https://cdl-parser.gemmology.dev
repo_url: https://github.com/gemmology-dev/cdl-parser
repo_name: gemmology-dev/cdl-parser

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2

nav:
  - Home: index.md
  - CDL Specification: specification.md
  - API Reference: api.md
  - CLI Usage: cli.md
  - Examples: examples.md
  - "Try interactive ↗": https://gemmology.dev/playground/

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - tables

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/gemmology-dev
      name: GitHub
    - icon: fontawesome/solid/flask
      link: https://gemmology.dev/playground/
      name: CDL Playground
    - icon: fontawesome/solid/graduation-cap
      link: https://gemmology.dev/quiz/
      name: Practice quiz
    - icon: fontawesome/solid/gem
      link: https://gemmology.dev/gallery/
      name: Crystal gallery
    - icon: fontawesome/solid/book
      link: https://gemmology.dev/learn/
      name: Learn (FGA)