Appearance
Tutorials
Structure
- skeleton.json # list of tutorials with their titles
- tutorial_folder/ # folder for a tutorial
- index.md # tutorial text in Markdown
- images/ # images used in the tutorial
- files/ # tutorial code, will be available as a zip
How to add a tutorial
- Create a folder for it
- Write your tutorial in
your_tutorial_name/index.md
, use Github-flavoured Markdown - In case your first first-level header is the same as the tutorial title from
skeleton.json
, it will be omitted. - Link images from
your_tutorial_name/images
, relative paths - Link code from
your_tutorial_name/files
, relative paths - Register your tutorial in
skeleton.json
, following the scheme"your_tutorial_title": "your_tutorial_name"
Add a multi-file tutorial
- Put the tutorial parts in Markdown put files into the tutorial folder
- Create TOC in
your_tutorial_name/skeleton.json
in the same format, the file will be also used to create the sub-menu