Skip to content
A User's Manual for Cuberite
HTML Python
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
book
out
static
.travis.yml
LICENSE
README.md
generate.py
style.css
template.html

README.md

users-manual

A User's Manual for Cuberite

There is an automatically updated version of the manual at book.cuberite.org, which updates every hour if a new commit has been pushed to this repository.

Developers' Area

This book is structured as individual HTML snippets for each chapter. The filename describes the section number and also the name of the section, separated by " - ".

A sample input directory structure would be:

/
|> 0 - Introduction/
|   |> 1 - Intro.html
|   |> 2 - Notes.html
|> 1 - Setting Up/
|   |> 1 - Downloading.html
|   |> 2 - Running.html

The idea is that the generator, combines the files to form 2 outputs - one standalone HTML page with all sections integrated and internal links, and another with each file (or section?) being a separate page. At the moment the generator only compiles to a single page, but multiple page is planned.

Here is a guide to writing:

Links to another section are automatically generated like so - {{Section Number - Text of Link}}.

Here is a list of semantically correct and styled HTML elements for specific purposes:

  • <p> For Paragraphs
  • <h4> For Headings
  • <aside class="infobox"> For information tangentially related to the content.
  • <aside class="warnbox"> For a warning related to the content.
  • <figure class="codebox"> For a code sample, with nested <pre> and <code> tags. Optionally with a <figcaption> for a caption.
  • <figure class="imgbox" For an image/screenshot. Optionally with a <figcaption> for a caption.
You can’t perform that action at this time.