Ingo converts AsciiDoc files in a directory to HTML using Asciidoctor and creates index files. It is built for collecting notes in AciiDoc format and presenting them.

If you are looking for a general purpose static site generator, I recommend looking at Jekyll or Hugo.

Ingo operates on a directory. It takes all .adoc files inside the docs directory into account and writes .html files to output.

It is recommended to add topics to each file.

For example

defines three topics. Ingo will create an index file for each topic linking to all documents with that topic. Think of topics as "Categories" in a wiki. Ingo is meant to provide an alternative to wikis for note taking for individuals and teams. In combination with Github/Gitlab and a CI service it can provide a similar experience for technical users.

An example project can be found at https://gitlab.com/fwilhe/berlin.

It is also possible to use ingo in a container

Yes, I was thinking about Hugo and just took another male name.

This is still work in progress. It needs automation wherever possible.

• Update changelog for upcoming release

• Remove .unreleased suffix from version and commit as "prepare release"

• bundle exec rake release (Creates and pushes the git tag and releases the artifact to ruby gems)

• Update version and append .unreleased and commit as "prepare for next development iteration"