init #

There is some minimal boilerplate that is the same for every new documentation. It’s for this purpose that romero includes an init command.

The init command is used like this:

$> romero init --title "My Project"

When using the init command for the first time, a couple of files will be set up for you:

$> 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

Specify a directory #

The init command can take a directory as an argument to use as the documentation’s root instead of the current working directory:

$> romero init documentation/

--title #

Specify a title for the documentation.

--ignore #

Creates a VCS ignore file (i.e. .gitignore) configured to ignore the documentation’s output. Default to none.

--templates #

When you use the template flag, all the themes and template will be copied in a directory called templates/:

$> romero init --title "My project" --templates
5:27PM INF Bootstrapping documentation in directory './'

$> tree
.
├── book.toml
├── src
│   └── SUMMARY.md
└── templates
    └── html
        ├── css
        │   ├── all.min.css
        │   ├── bulma.min.css
        │   ├── default.css
        │   └── main.css
        ├── footer.j2
        ├── header.j2
        ├── js
        │   ├── elasticlunr.min.js
        │   ├── live-reload.js
        │   ├── main.js
        │   ├── mark.min.js
        │   └── search.js
        ├── nav.j2
        └── webfonts
            ├── fa-brands-400.ttf
            ├── fa-brands-400.woff2
            ├── fa-regular-400.ttf
            ├── fa-regular-400.woff2
            ├── fa-solid-900.ttf
            ├── fa-solid-900.woff2
            ├── fa-v4compatibility.ttf
            └── fa-v4compatibility.woff2

7 directories, 22 files

You can then modify these files to suit your needs. You can also delete any files in those directories, and romero will use the default ones on building.