diff --git a/README.md b/README.md index 057f6ee..faf43e4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@ Minetest Doc ============ -Minetest Tutorials +This online book will teach you how to create mods in easy chapters.\\ +The chapters will explain a concept, give examples, and set tasks for you to complete. -Edit site in _config.yml to point to root url. -If using jekyll serve, then http://localhost:4000 +This documentation was created by the Minetest community in order to\\ +help new modders gain a foothold. + +You can contribute to this project on GitHub.\\ +It uses Jekyll to turn Markdown into a website. + +Book written by rubenwardy and contributers.\\ +License: CC-BY-NC-SA 3.0 + +Running +------- ``` -$ jekyll serve +$ jekyll serve -b /minetest_doc ``` + +Commits +------- + +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. diff --git a/_includes/header.html b/_includes/header.html index 08e39a7..9aeb67a 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -1,7 +1,7 @@ - {% if page.title != "Minetest Tutorial" %}{{ page.title }} - {% endif %}Minetest Tutorials and Documentation + {% if page.title != "Minetest Tutorials and Documentation" %}{{ page.title }} - {% endif %}Minetest Tutorials and Documentation @@ -12,3 +12,4 @@
  • 1 - Getting Started
    • +

    {{ page.title }}

    diff --git a/started.md b/chapters/chapter1_started.md similarity index 96% rename from started.md rename to chapters/chapter1_started.md index 200dc63..f48d55a 100644 --- a/started.md +++ b/chapters/chapter1_started.md @@ -1,11 +1,9 @@ --- -title: Chapter One - Getting Started +title: Chapter 1 - Getting Started layout: default +permalink: started/index.html --- -Chapter One – Getting Started -============================= - Introduction ------------ diff --git a/index.md b/index.md index 5edb4dd..275717e 100644 --- a/index.md +++ b/index.md @@ -1,12 +1,9 @@ --- -title: Minetest Tutorial +title: Minetest Tutorials and Documentation permalink: index.html layout: default --- -Minetest Tutorials and Documentation -==================================== - What is this? -------------