The wiki is hosted through GitHub pages, with the source code located in a separate GitHub repository.
Installation
- Clone the repository
- Navigate to the root folder (it should contain
README.md)
You can modify files and contribute now. If you want to host locally for rapid iteration:
- Make sure you have:
Ruby(>= 3.0 recommended)Bundler
- Verify your install:
ruby -vbundle -v
- Setup (first time only):
bundle install
- Start the deployment server:
bundle exec jekyll serve
- You can access the website at
http://localhost:4000/Wiki
Organization
- Place all tutorials under
docs/tutorial_name/ - Place all media under
assets/images/tutorial_name/orassets/videos/tutorial_name/, etc. - Under
_includes/there are helper html files that act like functions that can accept arguments. For instance,<img src="/Wiki/assets/images/first_car/aio.png" alt="" width="25%" loading="lazy" />includes an image fromassets/first_car/aio.pngwith width set to 25%. - You generally should not need to touch any files or folders starting with
_, such as_sass/,_layouts/,_config.yml. Please contact us if you need to modify them.
Libraries/Frameworks
- We use Jekyll to generate the html files for our website. Most of the time you will be working with Markdown files (similar to discord’s formatting), rather than html directly.
- We use Just The Docs as our Jekyll theme. This is mainly for styling and you are not required to understand it.