Quickstart #

You’ll need to compile or install romero before you can carry-on. See the Compilation section of this documentation.

Create the documentation structure #

Before anything, you’ll need to create the directory structure for romero. Go inside the desired documentation directory, and run the init routine of the command line:

$> cd documentation/
$> romero init --title "My Project"

The cli will generate a default tree, with a basic configuration:

$> tree
.
├── book.toml
└── src
    └── SUMMARY.md

2 directories, 2 files

[book]
  language = "en"
  src = "src"
  title = "My project"
  description = ""

[build]
  build-dir = "book"
  create-missing = true

You can then edit the configuration to add more information on your documentation.

Adding pages #

Once the basic structure has been created, you can start to add pages to your documentation. In order to do that, open the SUMMARY.md file in your src/ directory, and add a page:

 - [Romero Documentation](Romero.md)
 - [Quickstart](Quickstart.md)
     - [Subsection](Quickstart/Subsection.md)
+- [My new page](my-new-page.md)

You can then create the corresponding file and begin working on it, or let romero create it automatically with build or serve.

Working on content #

To work on the actual content, you can start a live webserver of the rendered documentation with:

$> romero serve

Which will render the HTML and serve it on http://localhost:8002 by default. For every change made to the file, the server will detect it, rebuild it, and live-reload the render in the browser directly.

Edit my-new-page.md and see for yourself! For the markdown formatting in the document, see the Markdown section of this documentation.

Building content #

Once you’re satisfied if the changes, you can then build your documentation to upload it somewhere:

$> romero build

romero will build a static version of the documentation, inside the book/ directory. You can then take that output and upload it wherever you like.