https://github.com/cuberite/users-manual

A User's Manual for Cuberite
https://github.com/cuberite/users-manual

website

Last synced: about 2 months ago
JSON representation

A User's Manual for Cuberite

• Host: GitHub
• URL: https://github.com/cuberite/users-manual
• Owner: cuberite
• License: other
• Created: 2014-04-08T17:21:30.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T21:11:28.000Z (8 months ago)
• Last Synced: 2024-04-23T23:10:29.359Z (8 months ago)
• Topics: website
• Language: HTML
• Homepage: http://book.cuberite.org
• Size: 593 KB
• Stars: 15
• Watchers: 14
• Forks: 13
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
users-manual

============

A User's Manual for Cuberite

There is an automatically updated version of the manual at [book.cuberite.org](https://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:

 * `
` For Paragraphs

 * `
` For Headings

 * `` For information tangentially related to the content.

 * `` For a warning related to the content.

 * `` For a code sample, with nested `
` and `` tags. Optionally with a `` for a caption.

 * `` for a caption.