lagrange-docs/mkdocs.yml at docs · adobe/lagrange-docs · 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
site_name: Lagrange
site_url: 'https://opensource.adobe.com/lagrange-docs/'
edit_uri: 'https://github.com/adobe/lagrange-docs/edit/docs/docs/open'
docs_dir: 'docs/open'
theme:
  name: 'material'
  logo: img/Lagrange-logo.svg
  icon:
    repo: fontawesome/brands/github
  palette:
    primary: red
    accent: red
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - content.action.edit

repo_name: adobe/lagrange
repo_url: https://github.com/adobe/lagrange

markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - footnotes
  - md_in_html
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg

plugins:
  - search
  - img2figv2
  - bibtex:
      bib_file: "refs.bib"
      csl_file: acm-siggraph.csl
      cite_inline: True
  - macros:
      include_yaml:
        - macros.open.yml
  - redirects:
      redirect_maps:
        'UserGuide/Core/Attributes.md': 'user/core/attributes.md'
        'user/core/utility-functions.md': 'user/core/general-utilities.md'

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/extra.js
  - javascripts/tables.js
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/extra.css

nav:
  - Home:
    - index.md
    - Goals: goals.md
    - Getting Started: setup/index.md
    - Build: build.md
    - Contribute: dev/contribute.md
    - Code Style: dev/code-style.md
    - Changelog: https://github.com/adobe/lagrange/releases
    - Third Party Libraries: third-party.md
  - User Guide:
    - General:
      - Mesh Class: user/core/mesh.md
      - Mesh Attributes: user/core/attributes.md
      - Mesh Utilities: user/core/mesh-utilities.md
      - General Utilities: user/core/general-utilities.md
      - Legacy Features:
        - Legacy Mesh Class: user/core/legacy-mesh.md
        - Legacy Mesh Attributes: user/core/legacy-attributes.md
        - Mesh Cleanup: user/core/mesh-cleanup.md
    - UI:
      - Overview: user/ui/overview.md
      - Entity Component System: user/ui/ecs.md
      - Mesh Visualization: user/ui/mesh-visualization.md
      - Components: user/ui/components.md
      - Lights: user/ui/lights.md
      - User Interface: user/ui/user-interface.md
      - Viewports: user/ui/viewports.md
      - Customizing Lagrange UI: user/ui/customizing.md
      - Examples: user/ui/examples.md
  - Dev Guide:
      - Lagrange:
        - Contribute: dev/contribute.md
        - Code Style: dev/code-style.md
        - Unit Tests: dev/unit-tests.md
      - Performance:
        - Profiling Runtime With Tracy: dev/runtime-profiling.md
        - Profiling Compilation Times: dev/compilation-profiling.md
        - Speeding Up Compilation: dev/speeding-up-compilation.md
      - Development:
        - VSCode Tips and Tricks: dev/vscode.md
        - Autocompletion With Clangd: dev/clangd.md
        - VisualStudio and WSL: dev/visualstudio-wsl.md

  - C++ Reference:
    - Home: cpp/index.html

  - Python Reference:
    - Home: python/index.html