#literator

[implicitly-notes]

literator 0.7.0

Command line application is removed, because (according to bintray) nobody uses it anyway

Library and sbt-plugin are merged into one project (because sbt multiproject is a mess)

Index is not appended by default now (you can turn it on with docsAddIndex := true)

Output directories are cleaned up before generating docs (you can turn it off with docsCleanBefore := false)

literator-plugin is renamed to just literator and is now an auto plugin

Literator is an sbt-plugin for transforming sources to markdown documents, allowing to use literate programming style with Scala and other languages.

[implicitly-notes]

literator 0.6.0

New feature:

Now you can add markdown files in the source directories (like Readme.md) with comments about the structure of your code or any other relevant documentation and it will be copied to the generated docs, making them more readable

Links index is added to them, so you can easily refer to other files

Literator is a simple tool for transforming sources to markdown documents, allowing to use literate programming style with Scala and other languages.

[implicitly-notes]

literator 0.5.0

Library:

#12: Fixed the way of writing to a file;

General refactoring and simplification of parsers;

Changed convention about indentation (see docs);

Command line application:

Using Conscript for simpler installation;

Using Scallop for command line options parsing;

Now it can generate docs for several source directories (as the sbt plugin could before);

Sbt plugin:

Added Literator. namespace for the keys;

Literator is a simple tool for transforming sources to markdown documents, allowing to use literate programming style with Scala and other languages.

[implicitly-notes]

literator 0.4.0

For better modularity and convenience of use, separated project into several parts:

Library:

Added autogenerated links definition list (#7)

Changed index building and moved index to the bottom of the document

Solved problem of nested comments (#4)

Abstracted parsing over particular language (#1); Added the most useful languages

Made everything more File-centric (instead of just Strings);

Merged literateFile/Dir into one File.literate() method;

Sbt plugin:

Has docsMap key, for multiple mapping between srcs -> doc dirs

Has docsOutputDirs for adding them to cleanFiles

Command line application:

So far very primitive application; planning to add some nice options and conscript cover.

Other changes:

Changed organization in sbt and package prefix in code to laughedelic

Now publishing everything to Bintray

Literator is a simple tool for transforming sources to markdown documents, allowing to use literate programming style with Scala and other languages.

[implicitly-notes]

literator 0.3.0

Restructured project: separated different components

Added (optional) navigation index to the generated markdown

Changed interface to use File/Path everywhere

Changed type of literateFile/Dir: now it returns error messages if there are any

Changed default docs destination from docs/code to docs/src

Literator is a simple tool to transform Scala sources to markdown documents, allowing to use literate programming style with Scala.

[implicitly-notes]

literator 0.2.0

added types for Comments and Code

simplified general parsers

completely rewrote comments parser with better margin handling

improved handling of empty lines; allowed them in comments with margin

allowed space as a margin delimiter: no need to use any special symbols, just make the correct indentation!

allowed to use escaped code in comments

Literator is a simple tool to transform Scala sources to markdown documents, allowing to use literate programming style with Scala.

[doumir-blog]

Article by at 2012-04-26 08:12:27 Categorized in Animal Photo,