-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathmkdocs.yml
145 lines (138 loc) · 4.76 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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: "encantar.js: GPU-accelerated Augmented Reality for the web"
site_url: https://encantar.dev
site_author: Alexandre Martins
site_description: The Augmented Reality engine that will enchant you!
copyright: Copyright © 2022 - present Alexandre Martins
repo_name: alemart/encantar-js
repo_url: https://github.com/alemart/encantar-js
theme:
name: material
custom_dir: docs_overrides
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
palette:
primary: deep purple
accent: yellow
logo: 'img/logo.png'
favicon: 'img/favicon.png'
extra_css: [ 'style/extra.css' ]
extra_javascript: [ 'js/extra.js' ]
plugins:
- search
- mkdocs-simple-hooks:
hooks:
on_post_build: 'docs.hooks:copy_static_files'
- redirects:
redirect_maps:
'api/index.md': 'api/ar.md'
markdown_extensions:
- admonition
- attr_list
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.details
- md_in_html
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:pymdownx.emoji.gemoji
emoji_generator: !!python/name:pymdownx.emoji.to_png
#emoji_index: !!python/name:materialx.emoji.gemoji
#emoji_generator: !!python/name:materialx.emoji.to_svg
dev_addr: 127.0.0.1:8008
nav:
- 'Home':
- 'Home': 'home.md'
- 'Download': 'download.md'
- 'Demos': 'demos.md'
- 'Add-Ons': 'addons/index.md'
- 'Learn': 'tutorial/index.md'
- 'API Reference': 'api/index.md'
- 'Support my work': 'support-my-work.md'
- 'License': 'license.md'
- 'Download': 'download.md'
- 'Demos':
- 'Demos': 'demos.md'
- 'Add-Ons':
- 'Add-Ons': 'addons/index.md'
- 'AR Button API': 'addons/ar-button.md'
- 'AR Clickable API': 'addons/ar-clickable.md'
- 'Video Player API': 'addons/ar-video-player.md'
- 'Asset Manager API': 'addons/asset-manager.md'
- 'More Add-Ons': 'addons/more-addons.md'
- 'Learn':
- 'Introduction': 'tutorial/index.md'
- 'Concepts': 'tutorial/concepts.md'
- 'Set up a web server': 'tutorial/set-up-a-web-server.md'
- 'Set up the tracker': 'tutorial/set-up-the-tracker.md'
- 'Set up the session': 'tutorial/set-up-the-session.md'
- 'Activate your webcam': 'tutorial/activate-your-webcam.md'
- 'Augment the scene': 'tutorial/augment-the-scene.md'
- 'Next steps': 'tutorial/next-steps.md'
- 'Recommendations': 'recommendations.md'
- 'Guidelines for Images': 'guidelines-for-images.md'
- 'Questions & Answers': 'faq.md'
- 'API Reference': 'api/index.md'
- 'API':
- 'General':
- 'AR': 'api/ar.md'
- 'Session': 'api/session.md'
- 'Frame': 'api/frame.md'
- 'Time': 'api/time-manager.md'
- 'Settings': 'api/settings.md'
- 'Resolution': 'api/resolution.md'
- 'Plugins':
- 'A-Frame': 'api/plugin-aframe.md'
- 'Babylon.js': 'api/plugin-babylon.md'
- 'Three.js': 'api/plugin-three.md'
- 'Trackers':
- 'Image tracker':
- 'ImageTracker': 'api/image-tracker.md'
- 'ReferenceImage': 'api/reference-image.md'
- 'ReferenceImageDatabase': 'api/reference-image-database.md'
- 'ImageTrackerResult': 'api/image-tracker-result.md'
- 'TrackableImage': 'api/trackable-image.md'
- 'Pointer tracker':
- 'PointerTracker': 'api/pointer-tracker.md'
- 'PointerTrackerResult': 'api/pointer-tracker-result.md'
- 'TrackablePointer': 'api/trackable-pointer.md'
- 'Tracker': 'api/tracker.md'
- 'TrackerResult': 'api/tracker-result.md'
- 'Trackable': 'api/trackable.md'
- 'Sources':
- 'CameraSource': 'api/camera-source.md'
- 'CanvasSource': 'api/canvas-source.md'
- 'VideoSource': 'api/video-source.md'
- 'PointerSource': 'api/pointer-source.md'
- 'Source': 'api/source.md'
- 'Visualization':
- 'Viewport': 'api/viewport.md'
- 'HUD': 'api/hud.md'
- 'Gizmos': 'api/gizmos.md'
- 'Geometry':
- 'Pose': 'api/pose.md'
- 'Viewer': 'api/viewer.md'
- 'ViewerPose': 'api/viewer-pose.md'
- 'View': 'api/view.md'
- 'PerspectiveView': 'api/perspective-view.md'
- 'Transform': 'api/transform.md'
- 'Vector2': 'api/vector2.md'
- 'Vector3': 'api/vector3.md'
- 'Quaternion': 'api/quaternion.md'
- 'Ray': 'api/ray.md'
- 'Events':
- 'AREvent': 'api/ar-event.md'
- 'AREventListener': 'api/ar-event-listener.md'
- 'AREventTarget': 'api/ar-event-target.md'
- 'AREventType': 'api/ar-event-type.md'
- 'Speedy':
- 'Speedy': 'api/speedy.md'
- 'SpeedySize': 'api/speedy-size.md'
- 'SpeedyMatrix': 'api/speedy-matrix.md'
- 'SpeedyPromise': 'api/speedy-promise.md'