Skip to content
Render, build, and publish markdown formatted content
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
LICENSE
README.md
config.js
package-lock.json
package.json

README.md

author title date tags
James Ackman
woola
2017-07-13 09:59:58 -0700
markdown, parser, render, file watcher, livereload, pandoc, commonmark, html, pdf, latex, citeproc, word, manuscript, lab notebook, citation, bibliography
 _      ____  ____  _     ____ 
/ \  /|/  _ \/  _ \/ \   /  _ \
| |  ||| / \|| / \|| |   | / \|
| |/\||| \_/|| \_/|| |_/\| |-||
\_/  \|\____/\____/\____/\_/ \|

woola– A friendly beast who builds and serves content for you.

Installation

First, ensure you have installed node.js & npm.

Then install into a local project directory:

npm install https://github.com/ackmanlab/woola.git

Or install globally (may need to sudo)... so the app can be run from anywhere:

npm install -g https://github.com/ackmanlab/woola.git

Usage

If you have project directory (web app/site, personal/lab notebook repo) containing markdown files (e.g. CommonMark format with .md, .mmd, or .txt file extensions) then simply navigate to your project and run woola for a live preview in your browser:

cd path/to/myproject/
woola

Or run woola -b to build a static html site based on the markdown and html files in your directory:

woola -b

For optimal usage, add custom css styles for the included pdf export functionality-- try ackmanlab/libcss for combined screen/print css already configured for use with woola (just clone libcss locally and add a symlink for your current project directory ln -s path/to/libcss/build ./myproject/css).

License

MIT License

You can’t perform that action at this time.