Laughedelic Literator Versions Save

:memo: Generate literate-style markdown docs from your sources

v0.8.0

6 years ago
  • #24, #28: Updated Scala parser combinators dependency, Scala version to 2.12
  • Published sbt plugin for sbt-1.x

v0.7.1

7 years ago

This release just fixes problems with resolving artifacts from Bintray. It doesn't have any significant changes since 0.7.0.

v0.7.0

8 years ago
  • 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

v0.6.0

9 years ago

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

v0.5.2

10 years ago
  • Fixed encoding bug (java.nio.charset.MalformedInputException: Input length = 1 exception) (See #16)
  • Updated dependencies (ScalaTest, Scallop)

v0.5.1

10 years ago

Fixed line endings handling (Windows CRLF) (#15)

v0.4.1

10 years ago
  • Bugfix for #12 (issue with writing to files on windows)

v0.5.0

10 years ago
  • 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;

v0.4.0

10 years ago

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

v0.3.0

10 years ago
  • 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