Git Product home page Git Product logo

monako's Introduction

monako

Build Monako codecov Go Report Card GoDoc Maintainability

monako logo


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

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 Dockerhub.

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

Screenshot of a documentation site built with Monako

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.

monako's People

Contributors

snipem avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.