forked from datoviz/datoviz
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
91 lines (91 loc) · 2.98 KB
/
mkdocs.yml
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
site_name: Datoviz Documentation
repo_url: https://github.com/datoviz/datoviz
site_description: High-performance interactive scientific data visualization library
site_author: Cyrille Rossant
theme:
name: material
logo: images/logow.png
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.expand
- toc.integrate
icon:
repo: fontawesome/brands/github
extra_css:
- stylesheets/extra.css
markdown_extensions:
- toc:
permalink: true
toc_depth: 3
- abbr
- admonition
- attr_list
- pymdownx.tilde
- pymdownx.highlight
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
- search
- mkdocs-simple-hooks:
hooks:
# on_config: "utils.hooks:config_hook"
# on_nav: "utils.hooks:nav_hook"
on_page_markdown: "utils.hooks:page_hook"
nav:
- Home: 'index.md'
- Getting started:
- Index: 'tutorials/index.md'
- Installation: 'tutorials/install.md'
- Quickstart: 'tutorials/quickstart.md'
- Examples:
- Overview: 'examples/index.md'
- Quickstart tutorial: 'examples/quickstart.md'
- Image blending: 'examples/image.md'
- France departements: 'examples/france.md'
- Digital signals: 'examples/signals.md'
- 3D brain mesh: 'examples/brain.md'
- Two panels: 'examples/twopanels.md'
- Custom colormap: 'examples/colormap.md'
- Async event loop: 'examples/eventloop.md'
- How to guides:
- Index: 'howto/index.md'
- Standalone C apps:
- How to use the scene C API: 'howto/standalone_scene.md'
- How to use the canvas C API: 'howto/standalone_canvas.md'
- How to use the vklite C API: 'howto/standalone_vklite.md'
- How to use Dear ImGui directly: 'howto/standalone_imgui.md'
- Custom visuals and graphics:
- How to write a custom visual: 'howto/visual.md'
- How to write a custom graphics: 'howto/graphics.md'
- Reference:
- Index: 'reference/index.md'
- Library of visuals: 'reference/visuals.md'
- Library of graphics: 'reference/graphics.md'
- Library of colormaps: 'reference/colormaps.md'
- Library of controllers: 'reference/controllers.md'
- C API reference:
- Index: 'api/index.md'
- Scene API: 'api/scene.md'
- Visual API: 'api/visual.md'
- Controller API: 'api/controller.md'
- GUI API: 'api/gui.md'
- Canvas API: 'api/canvas.md'
- GPU API: 'api/gpu.md'
- vklite API: 'api/vklite.md'
- Misc API: 'api/misc.md'
- Enumerations: 'api/enums.md'
- Discussions:
- Index: 'discussions/index.md'
- For users:
- Vulkan crash course: 'discussions/vulkan.md'
- Best practices: 'discussions/practices.md'
- FAQ: 'discussions/faq.md'
- For developers:
- Library architecture: 'discussions/architecture.md'
- Developer notes: 'discussions/developer.md'
- Developer checklists: 'discussions/checklists.md'