Giter Club home page Giter Club logo

metadocs's Introduction

MetaDocs

Build Status

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 and Jekyll themes

Links

License

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

Authors

  • Tim Nieradzik

metadocs's People

Contributors

tindzk avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

metadocs's Issues

Formatting jumps

The caption of jumps (i.e. links to other chapters or sections) should be more customisable. For example, instead of the chapter name, the user may want to use its number instead (e.g. "Chapter 1" or "Section 1.2"). Document.toDocumentTree could take a function similar to generateId.

Reporting errors

A user should have the possibility of reporting errors/suggestions in the generated manual. This could be implemented by integrating the GitHub issues API.

Set constants programmatically

When writing a manual for a library, there are certain constants like package names or version numbers which often appear several times throughout the document. As for Scala projects, a user may want to extract the version number directly from the build.sbt, so that the manual can be easily kept in sync.

Draft/release mode

Support different modes: in the 'release' mode, todos should be hidden.

Global parameter "draft"

Every element should have the Boolean parameter draft. A function filterDraftNodes() could be provided to exclude those elements from the generated HTML file.

sbt plugin

Write an sbt plugin, so that the manual generation can be made part of the build process.

Improve paragraph detection

The following three paragraphs should not be merged:

a

bold{b} c

bold{d}

The paragraph detection must be covered by test cases as it's too complicated already.

Support Inserting Chapters

Currently the chapters are organized starting with "ch00" and incrementing up. What if I want to inject a new chapter in the middle? This means I have to go through and rename every following chapter file name.

Show errors when compilation of Scala project fails

The following error is not meaningful:

[error] (run-main-0) java.lang.RuntimeException: Nonzero exit value: 1
java.lang.RuntimeException: Nonzero exit value: 1
        at scala.sys.package$.error(package.scala:27)
        at scala.sys.process.ProcessBuilderImpl$AbstractBuilder.slurp(ProcessBuilderImpl.scala:132)
        at scala.sys.process.ProcessBuilderImpl$AbstractBuilder.$bang$bang(ProcessBuilderImpl.scala:102)
        at pl.metastack.metadocs.document.writer.SbtScala$$anonfun$runProjects$1.apply(SbtScala.scala:153)
        at pl.metastack.metadocs.document.writer.SbtScala$$anonfun$runProjects$1.apply(SbtScala.scala:150)
...

LaTeX support

It should be fairly straightforward to add support for LaTeX and PDF generation. As in Pandoc, the user should have the possibility to specify a custom template.

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.