introduce the senseglove unreal engine handbook

2024-08-16 18:01:41 +02:00
parent d69eb6cd96
commit fb876cc236
25 changed files with 1005 additions and 304 deletions
@@ -0,0 +1,86 @@
+#
+# author: Mamadou Babaei <mamadou@senseglove.com>
+#
+# (The MIT License)
+#
+# Copyright (c) 2020 - 2024 SenseGlove
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+[book]
+authors = ["Mamadou Babaei"]
+description = "Welcome to the SenseGlove Unreal Engine documentation!"
+language = "en"
+multilingual = false
+src = "src"
+text-direction = "ltr"
+title = "The SenseGlove Unreal Engine Handbook"
+
+[build]
+build-dir = "book"
+create-missing = false
+extra-watch-dirs = ["assets"]
+use-default-preprocessors = true
+
+[preprocessor.index]
+
+[preprocessor.links]
+
+[preprocessor.senseglove]
+after = [ "index", "links" ]
+command = "sh ./bin/sg-preprocessor.sh"
+
+[output.html]
+additional-css = ["styles/custom.css"]
+additional-js = []
+cname = "unreal.docs.senseglove.com"
+copy-fonts = true
+default-theme = "navy"
+edit-url-template = "https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal?path=/Handbook/{path}"
+git-repository-url = "https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal"
+git-repository-icon = "fa-git"
+input-404 = "404.md"
+mathjax-support = false
+no-section-label = false
+preferred-dark-theme = "navy"
+site-url = "/example-book/"
+smart-punctuation = false
+theme = ""
+
+[output.html.fold]
+enable = false
+level = 0
+
+[output.html.print]
+enable = true
+page-break = true
+
+[output.html.search]
+boost-hierarchy = 1
+boost-paragraph = 1
+boost-title = 2
+copy-js = true
+enable = true
+expand = true
+heading-split-level = 3
+limit-results = 128
+teaser-word-count = 64
+use-boolean-and = true
+