{"id":15204298,"url":"https://github.com/snipem/monako","last_synced_at":"2025-10-29T05:31:50.511Z","repository":{"id":48060200,"uuid":"216070542","full_name":"snipem/monako","owner":"snipem","description":"Multi repository static site generator for Markdown and Asciidoc documentation","archived":false,"fork":false,"pushed_at":"2024-06-26T19:37:59.000Z","size":3727,"stargazers_count":38,"open_issues_count":4,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T06:41:28.435Z","etag":null,"topics":["documentation-toolchain","git","hugo"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snipem.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-18T17:00:25.000Z","updated_at":"2024-10-21T17:04:09.000Z","dependencies_parsed_at":"2024-05-14T13:44:40.237Z","dependency_job_id":null,"html_url":"https://github.com/snipem/monako","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipem%2Fmonako","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipem%2Fmonako/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipem%2Fmonako/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipem%2Fmonako/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snipem","download_url":"https://codeload.github.com/snipem/monako/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238777907,"owners_count":19528813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-toolchain","git","hugo"],"created_at":"2024-09-28T05:41:21.060Z","updated_at":"2025-10-29T05:31:45.124Z","avatar_url":"https://github.com/snipem.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# monako\n\n!!!\n\n**This project is no longer actively maintained. Use it at your own risk.**\n\n!!!\n\n\n## About\n\n![Build Monako](https://github.com/snipem/monako/workflows/Build%20Monako/badge.svg?branch=develop)\n[![codecov](https://codecov.io/gh/snipem/monako/branch/master/graph/badge.svg)](https://codecov.io/gh/snipem/monako)\n[![Go Report Card](https://goreportcard.com/badge/github.com/snipem/monako)](https://goreportcard.com/report/github.com/snipem/monako)\n[![GoDoc](https://godoc.org/github.com/snipem/monako?status.svg)](https://godoc.org/github.com/snipem/monako)\n[![Maintainability](https://api.codeclimate.com/v1/badges/1ff16e0c4f8a871bfac3/maintainability)](https://codeclimate.com/github/snipem/monako/maintainability)\n\n![monako logo](https://github.com/snipem/monako/raw/master/assets/logo/cover.png)\n\n----\n\nA less opinionated document aggregator and publisher. Easier to use and to adapt than Antora, Hugo, JBake and the likes.\n\n----\n\n## Purpose\n\nMonako abstracts the complexity of collecting documentation from a configurable amount of Git repositories (origins).\n\nMonako uses [Hugo](https://gohugo.io) as a static site generator but hides it to the user. It also uses the great [Hugo Book Theme](https://github.com/alex-shpak/hugo-book) which I forked at [Monako Book](https://github.com/snipem/monako-book).\n\n## How Monako works\n\n![How Monako works](https://github.com/snipem/monako/raw/master/assets/monako.png)\n\n## Usage\n\n```help\n$ monako -h\nUsage of monako:\n  -base-url string\n        Custom base URL\n  -config string\n        Configuration file (default \"config.monako.yaml\")\n  -fail-on-error\n        Fail on document conversion errors\n  -menu-config string\n        Menu file for monako-book theme (default \"config.menu.md\")\n  -compose\n        Only compose the Monako structure\n  -render\n        Only render HTML files from an existing Monako structure\n  -trace\n        Enable trace logging\n```\n\nA Docker image is available from [Github Packages](https://github.com/snipem/monako/pkgs/container/monako).\n\n## Configuration\n\n### Configuration of Origins\n\n```yaml\n---\n  baseURL : \"https://example.com/\"\n  title : \"My Projects\"\n\n  whitelist:\n    - \".md\"\n    - \".adoc\"\n    - \".jpg\"\n    - \".svg\"\n    - \".png\"\n\n  origins:\n  - src: https://github.com/snipem/commute-tube\n    branch: master\n    docdir: .\n    targetdir: docs/commute\n\n  - src: https://github.com/snipem/monako\n    branch: develop\n    docdir: doc\n    targetdir: docs/monako\n```\n\n### Configuration of Menus\n\n```markdown\n- **My Projects**\n  - [Commute Tube]({{\u003c relref \"/docs/commute/readme\" \u003e}})\n  - [Monako]({{\u003c relref \"/docs/monako/readme\" \u003e}})\n  ...\n```\n\n### Configuration of Documents\n\nMonako supports all [Hugo Frontmatter](https://gohugo.io/content-management/front-matter/) types (YAML, TOML and JSON).\nMonako converts them to YAML.\n\nAdd frontmatter as you wish at long as it's supported by Hugo and the Theme.\n\n#### Monako specific options\n\nHide Git links like \"edit this page\" and \"last edit by\". Add this line to the frontmatter of the document:\n\n```yaml\nMonakoGitLinks = false\n```\n\n### Screenshot\n\n![Screenshot of a documentation site built with Monako](https://github.com/snipem/monako/raw/master/assets/screenshot.png)\n\n## Design Goals\n\n* Make it simple and stupid, single binary with no dependencies ✓\n* Git clone existing repositories ✓\n  * Don't attempt to change their structure ✓\n  * Transform all documents below a specific structure ✓\n* Use Antora like configuration file for main structure ✓\n* Support Mermaid ✓\n\n## Features\n\n* Multi repository document fetching\n* Bundled dependencies (minus Asciidoctor)\n\n## Development\n\nInit with `make init`\n\n## Improvements\n\n* Support edit this page links with links to origin repository. Book theme provides a [similar feature](https://github.com/alex-shpak/hugo-book/search?q=BookRepo\u0026unscoped_q=BookRepo).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnipem%2Fmonako","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnipem%2Fmonako","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnipem%2Fmonako/lists"}