OpenSimplex2/mkdocs.yml at main · QuasarApp/OpenSimplex2 · 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
# OpenSimplex2 documentation site (GitHub Pages)
#
# Built with MkDocs + the Material theme. Before `mkdocs build` runs,
# the "Deploy Documentation (GitHub Pages)" workflow copies the root
# README.md to docs/index.md (the site home page) and generates the
# Doxygen HTML output into docs/api/, so the API section of the site
# is served from /api/.

site_name: OpenSimplex2
site_description: The most fast implementation of the OpenSimplex noise (2D, 3D and 4D) in C
site_url: https://quasarapp.github.io/OpenSimplex2/

repo_name: QuasarApp/OpenSimplex2
repo_url: https://github.com/QuasarApp/OpenSimplex2
edit_uri: https://github.com/QuasarApp/OpenSimplex2/edit/main/

docs_dir: docs
site_dir: site

theme:
  name: material
  palette:
    - scheme: default
      # Teal brand palette (intentionally different from the upstream
      # documentation theme), built only from Material's named colors so
      # the site needs no custom CSS. Teal top bar, teal links.
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      # Same teal top bar on the slate neutrals. The slate links are
      # derived from the primary color by the theme, so the same teal
      # accent keeps both schemes consistent (Material ships prebuilt
      # accent rules for the base color names only).
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  # index.md is copied from the root README.md by the documentation
  # workflow before the MkDocs build, so the README stays the single
  # source of truth and the generated copy is not committed.
  - Home: index.md
  # api/index.html is the static Doxygen index generated into docs/api/
  # by the documentation workflow before the MkDocs build.
  - API: api/index.html