Romero

Docs - Tickets - Send patches - Discuss - Announce

Welcome to romero, a utility to create modern online websites from Markdown files.

Features Highlights #

• Mostly compatible with mdbook
• Default theme compatible with multiple layouts
• Extended markdown parser
• Search engine

See live versions of romero:

• This documentation
• The Rust Programming Language
• MDBook

Docker #

Live view:

docker run --rm -v $(pwd):/book -w /book -p 3000:3000 ne02ptzero/romero:latest serve 0.0.0.0:3000

To build a book:

docker run --rm -v $(pwd):/book -w /book -p 3000:3000 ne02ptzero/romero:latest build

Getting started #

To run a local version of this project, please follow these simple steps.

Prerequisites #

• go (version >=1.24.0)
• git
• make

Set up #

Clone the repository

$> git clone https://git.sr.ht/~ne02ptzero/romero

Go inside the sources directory

$> cd romero

Compile the binary

$> make

You’re good to go!

Quickstart #

For a new project:

$> romero init --title "My project"
$> romero serve

For an existing mdbook:

$> romero serve

Contributing #

If you want to contribute, please send your patches to ~ne02ptzero/romero-devel@lists.sr.ht You can look at git-send-email.io if you need to setup your mail client.

Bug Report #

Please report your bugs by email at ~ne02ptzero/romero-discuss@lists.sr.ht

License #

All the code in this repository is released under the GLPV v3.0, for more information take a look at the LICENSE file.