Book written by rubenwardy. License: CC-BY-SA 3.0
_data/
- Contains list of languages_layouts/
- Layouts to wrap around each page.static/
- CSS, images, scripts._<lang>/
<section>/
- Markdown files for each chapter.I'm happy to fix the formatting of any chapters. It is the writing which is the hard bit, not the formatting.
Grammar and such:
color
andinitialize
.you
if you must. Never we
nor I
.Formatting:
your turn
s to the end of a chapter when relevant.To create a new chapter, make a new file in _en/section/. Name it something that explains what the chapter is about. Replace spaces with underscores ( _ )
---
title: Chapter Name
layout: default
root: ..
idx: 4.5
long_notice:
level: tip
title: This is a long tip!
message: This is a very long tip, so it would be unreadable if
placed in the main body of the chapter. Therefore,
it is a good idea to put it in the frontmatter instead.
---
## Chapter Name
Write a paragraph or so explaining what will be covered in this chapter.
Explain why/how these concepts are useful in modding
* [List the](#list-the)
* [Parts in](#parts-in)
* [This Chapter](#this-chapter)
## List the
{% include notice.html notice=page.long_notice %}
Paragraphs
\```lua
code
\```
## Parts in
## This Chapter
If you are editing or creating a particular chapter, then use commit messages like this:
Getting Started - corrected typos
Entities - created chapter
Just use a normal style commit message otherwise.
_en/
to your language code_data/languages.yml
collections
in _config.yml
layouts/default.html
I use Jekyll 3.8.0
# For Debian/Ubuntu based:
sudo apt install ruby-dev
gem install jekyll github-pages
You can build it as a website using Jekyll
$ jekyll build
Goes to _site/
You can start a webserver on localhost which will automatically rebuild pages when you modify their markdown source.
$ jekyll serve
This serves at http://localhost:4000 on my computer, but the port may be different. Check the console for the "server address"