Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

README.md

docbuilder Travis Status

This used to be a small build script that would compile some written notes and from a directory to html.

It sort of grew bigger as I wanted more features and automation, as a result this came into existence.

It is now a ~200 loc Haskell program featuring on demand markdown and ascii source file discovery and compilation (uses the pandoc library and asciidoctor executable), file system watching and subsequent automatic recompile as well as a server serving the compiled files and handling additional assets like js and css.

Requirements

Markdown compilation relies on the pandoc library and is directly linked into the program, thus requires no external resources.

Asciidoc compilation relies on asciidoctor being installed on your system in your $PATH.

Usage

$ docbuilder --help
Compile helper for asciidoc and markdown

docbuilder [OPTIONS] [COMMANDS]

Common flags:
  -s --sourcefolders=DIR         Root folders for the source files
  -p --port=INT                  Run the server on this port
  -t --pandoctemplate=FILE.html  A html template for the mardown compiler
  -i --indextemplate=FILE.html   Mustache template for the index page
  -? --help                      Display help message
  -V --version                   Print version information

Valid command are:

  • compile (chainable) -> Compile all new contents of the source directories into the build directory mirroring the structure
  • clean (chainable) -> Remove the build directory (recursively)
  • watch (non-chainable) -> Monitor the source directories for change, recompile the output on every change. Usually chained after compile, aka $ docbuilder compile watch
  • serve (non-chainable) -> Compile all new contents, create a webserver on the specified port serving the compiled files and watch for new changes in the source directories.

Non-chainable commands do not exit and block the execution. Hence any command after watch or serve will not be executed.

About

Building markdown and asciidoc notes

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.