gemmology-knowledge/mkdocs.yml at main · gemmology-dev/gemmology-knowledge · 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
site_name: Gemmology Knowledge
site_description: FGA curriculum documentation and study materials
site_url: https://knowledge.gemmology.dev
repo_url: https://github.com/gemmology-dev/gemmology-knowledge
repo_name: gemmology-dev/gemmology-knowledge

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

plugins:
  - search

nav:
  - Home: index.md
  - Learn:
      - Overview: learn/index.md
      - Crystal Systems: learn/crystal-systems.md
      - Physical Properties: learn/physical-properties.md
      - Optical Properties: learn/optical-properties.md
      - Inclusions: learn/inclusions.md
      - Treatments: learn/treatments.md
      - Synthetics: learn/synthetics.md
  - Knowledge Modules: modules.md
  - Quick Reference:
      - Overview: quick-reference/index.md
  - Study Guides:
      - FGA Foundation: study-guides/fga-foundation.md
      - FGA Diploma: study-guides/fga-diploma.md
  - Glossary: glossary.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - tables
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - abbr
  - footnotes

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/gemmology-dev
    - icon: fontawesome/solid/globe
      link: https://gemmology.dev