Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.68 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.68 KB

SBT PANDOC

This is an SBT 0.13 plugin which uses AutoPlugin and the PANDOC application to build markdown documentation artifacts from SBT. It assumes that pandoc is already installed on your machine.

This is a fairly simple SBT plugin, whitch I wrote to learn how to write plugins.

Building

You can build and publish the plugin in the normal way to your local Ivy repository:

sbt publish-local

Installation

You must first download the git project and build it. It is not available in the maven repository yet (it'll probably in future).

In project/plugins.sbt:

addSbtPlugin("com.scalway" % "sbt-pandoc" % "0.0.1")

In build.sbt:

pandocSrcFolder := "/doc/"                    //this is default 
pandocDstFolder := "/web/public/main/doc/"    //this'll produce all files to target/web/public/main/doc/

Usage

Once you have it installed, typing pandocGenerate at an SBT prompt will generate documentation artifacts from pandocSrcFolder. It'll combine all .md files to one document using alphabetical order. I use code structure like that:

./doc
├── 01_title
│   ├── 00_title_page.md
│   └── 01_about_document.md
├── 03_server
│   ├── 02_dev.md
├── 04_REST
│   ├── 01_abstract.md
│   ├── 02_Pagination.md
├── css
│   └── buttondown.css                 //all not .md files will be copied to pandocDstFolder
└── images                             //that means you can use relative paths in all .md files
    ├── paylo_icon.png                 //that means you can use relative paths in all .md files
    └── server_schema.png

Testing

TODO in future