{"repo":"dialogic-godot/documentation","free":true,"listed":false,"github":"https://github.com/dialogic-godot/documentation","clone":"git clone https://github.com/dialogic-godot/documentation.git","description":"📖 The documentation for the Dialogic Godot plugin.","language":"CSS","stars":29,"topics":["dialogic","godot","godot-engine"],"license":null,"category":"game-templates","readme_excerpt":"Dialogic 2 - Documentation Repository This repository contains the documentation of Dialogic 2. It utilises mdBook to generate and render the website. If you find a mistake, please open an issue. Adding a new page New pages should be added to the documentation folder. The SUMMARY.md file contains the table of contents displayed as a sidebar. Please add your new page to this file. Updating the website The md files can be displayed in many applications supporting markdown. However, the website is generated using mdBook . The website utilises a build script to generate the website and push it to the gh-pages branch. On GitHub, these build scripts are called GitHub Actions. Book Structure The documentation folder contains the book pages. The theme folder overrides the built-in mdBook style/theme files. The book.toml contains the configuration of the documentation book. A preprocessor decides how the book's chapters will be modified before building the final published book.\\ The preprocessors are not part of the built-in feature set and were developed by other developers.\\ They must be installed, see the .github/workflows/mdbook.yml for this. Run the documentation locally To build the documentation, we need its software mdBook , which is written in the Rust Programming Language. 1. First, install Rust: https://www.rust-lang.org/tools/install \\ Open a new console, this allows cargo to function and makes the following commands possible. 2. Let's install mdBook : cargo install mdbook","default_branch":null,"files":null,"tree":[],"storefront":"/r/dialogic-godot","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/dialogic-godot/documentation/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}