https://github.com/tindzk/metadocs

Documentation generation toolkit
https://github.com/tindzk/metadocs

documentation html scala

Last synced: 11 days ago
JSON representation

Documentation generation toolkit

• Host: GitHub
• URL: https://github.com/tindzk/metadocs
• Owner: tindzk
• Created: 2015-08-22T22:20:37.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-11T16:00:08.000Z (over 7 years ago)
• Last Synced: 2023-07-07T14:15:29.486Z (over 1 year ago)
• Topics: documentation, html, scala
• Language: Scala
• Size: 120 KB
• Stars: 1
• Watchers: 4
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MetaDocs

[![Build Status](https://travis-ci.org/MetaStack-pl/MetaDocs.svg)](https://travis-ci.org/MetaStack-pl/MetaDocs)

MetaDocs is a Scala library for generating documents.

## Features

* Markup language supporting arbitrary instructions

* Custom instructions can be defined

* Paragraphs are automatically detected

* Scala code listings are executed and embedded

* TOC generation

* Checked references to chapters/sections

* Constants

* Input formats: Markdown, MetaDocs

* Output formats: Markdown, HTML

* Document types: single-page, book, blog

* HTML output is compatible with [Marked](http://marked2app.com/help/Writing_Custom_CSS.html) and [Jekyll](http://jekyllrb.com/) themes

## Links

* [ScalaDoc](https://www.javadoc.io/doc/pl.metastack/metadocs_2.11/)

## License

MetaDocs is licensed under the terms of the Apache v2.0 license.

## Authors

* Tim Nieradzik