monako
monako copied to clipboard
Multi repository static site generator for Markdown and Asciidoc documentation
monako
!!!
This project is no longer actively maintained. Use it at your own risk.
!!!
About
A less opinionated document aggregator and publisher. Easier to use and to adapt than Antora, Hugo, JBake and the likes.
Purpose
Monako abstracts the complexity of collecting documentation from a configurable amount of Git repositories (origins).
Monako uses Hugo as a static site generator but hides it to the user. It also uses the great Hugo Book Theme which I forked at Monako Book.
How Monako works
Usage
$ monako -h
Usage of monako:
-base-url string
Custom base URL
-config string
Configuration file (default "config.monako.yaml")
-fail-on-error
Fail on document conversion errors
-menu-config string
Menu file for monako-book theme (default "config.menu.md")
-compose
Only compose the Monako structure
-render
Only render HTML files from an existing Monako structure
-trace
Enable trace logging
A Docker image is available from Github Packages.
Configuration
Configuration of Origins
---
baseURL : "https://example.com/"
title : "My Projects"
whitelist:
- ".md"
- ".adoc"
- ".jpg"
- ".svg"
- ".png"
origins:
- src: https://github.com/snipem/commute-tube
branch: master
docdir: .
targetdir: docs/commute
- src: https://github.com/snipem/monako
branch: develop
docdir: doc
targetdir: docs/monako
Configuration of Menus
- **My Projects**
- [Commute Tube]({{< relref "/docs/commute/readme" >}})
- [Monako]({{< relref "/docs/monako/readme" >}})
...
Configuration of Documents
Monako supports all Hugo Frontmatter types (YAML, TOML and JSON). Monako converts them to YAML.
Add frontmatter as you wish at long as it's supported by Hugo and the Theme.
Monako specific options
Hide Git links like "edit this page" and "last edit by". Add this line to the frontmatter of the document:
MonakoGitLinks = false
Screenshot
Design Goals
- Make it simple and stupid, single binary with no dependencies ✓
- Git clone existing repositories ✓
- Don't attempt to change their structure ✓
- Transform all documents below a specific structure ✓
- Use Antora like configuration file for main structure ✓
- Support Mermaid ✓
Features
- Multi repository document fetching
- Bundled dependencies (minus Asciidoctor)
Development
Init with make init
Improvements
- Support edit this page links with links to origin repository. Book theme provides a similar feature.