kokoi
v0.1.7
Published
Configurable markup file watcher, previewer and converter.
Downloads
5
Maintainers
zeisReadme
kokoi 
kokoi watches for changes on the markup files (Markdown, Textile, reStructuredText...) in the directory kokoi is started, and if they change, automatically reprocesses and previews them directly in the browser. You will work on your files without having to leave your favorite text editor!
The rendered HTML is optionally saved. kokoi is the perfect tool for those who like to keep notes in markup‑formatted files and who are always editing them.
You can also pass, as arguments, multiple markup files, or directories, which will be scanned recursively.
Additional features are, configurable command to process markup files, support for math formulas (rendered with MathJax), and support for custom HTML templates.
Installation
Install Node.js.
Install a markup processing engine such as Pandoc. By default kokoi is configured to watch for changes on Markdown files, and uses Pandoc to convert them, if Pandoc is not installed kokoi will try to use the fallback command
markdown. If you want to use a different engine, the appropriate command to convert markup files to HTML must be specified (see Usage).Then, run
npm install kokoi -gin a terminal.
Notes for Linux users:
To install kokoi globally, note that the preceding command must be run as root, also, make sure that npm is installed.
If you installed Node.js from a package manager, the Node.js binary may be called nodejs instead of node, run this command as root
ln -s /usr/bin/nodejs /usr/bin/nodeto create a symlink.
Usage
USAGE
kokoi [options] [files or dirs]
Examples:
kokoi -c "redcarpet --smarty" -s "My Notes" Dir2 test/Foo.md
kokoi -e rst -c "pandoc -f rst -t html5" foo.rst
If no file or directory is specified, the current directory (.)
is assumed. Directories are scanned recursively.
Subdirectories whose name is "node_modules" or "AppData" or starts
with a dot (.git, .hg...) are ignored.
OPTIONS
-p, --port
TCP port at which the HTML files will be served.
Default is 8333.
-c, --command
Command to convert markup files to HTML.
Default is "pandoc -f markdown -t -html5".
-s, --save
Save the rendered HTML. The output directory for each HTML
file is the same of the corresponding markup file.
-m, --mathjax
Insert a link to the MathJax CDN to render math formulas.
If the processing engine does not support math formulas
do not use this option.
-e, --extensions
Comma-delimited list of extensions of the files to watch
for changes, excluding the dots and without spaces.
Default is "md,markdown".
-t, --template
Path to your custom HTML template file. See README.md for
more information.
-v, --version
Show version.
-h, --help
Show this help message.Templates
Templates are custom HTML files to use as a container for the processed HTML.
A template file must not contain links to external resources such as images, style sheets or scripts, they must be embedded in the template itself, or alternatively hosted online.
A template must contain the following special variables used by kokoi: $title$, $scripts$ and $body$. As an example, the default template looks like this:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>$title$</title>
$scripts$
<style>
/* your css here */
</style>
</head>
<body>
$body$
</body>
</html>Contributing
If you see possible improvements, feel free to fork and contribute!
License
kokoi is available under the MIT License.