zapier/litdoc

Name: litdoc

Owner: Zapier

Description: :triangular_ruler: A simple Markdown-based 3-column documentation builder.

Created: 2016-07-30 23:02:09.0

Updated: 2017-11-21 17:44:06.0

Pushed: 2017-03-16 18:56:30.0

Homepage: http://litdoc.org

Size: 41

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Introduction

litdoc is a simple 3 column documentation generator. The most common use case is a single README.md. This file itself is a demo:

• View original Markdown README.md.
• View generated HTML documentation.

Installation & Usage

There are two ways to use litdoc, locally and globally.

Local Installation & Usage

If you only need litdoc for your current project, we recommend a local installation via npm.

m install litdoc --save-dev

You can use it as a CLI tool.

node_modules/.bin/litdoc input.md output.html

Or you can use it directly in your application, generating the HTML inline.

litdoc = require('litdoc');

enerate the HTML inline
documentationHtml = litdoc({
rkdown: '## Hello!\n\nThis is a sample doc.\n\n' +
        '```js\nvar hello = "world"\n```'

Or, you can optionally read/write to specific paths.

litdoc = require('litdoc');
path = require('path');

eads a markdown file and writes an HTML file
oc({
rkdownPath: path.join(__dirname, '../README.md'),
tputPath: path.join(__dirname, '../index.html')

Global Installation & Usage

If you'd prefer to make litdoc available across all your projects, you can install it locally with npm.

m install -g litdoc

You can use it as a CLI tool from anyplace on your machine.

tdoc input.md output.html

Reference

Below is the reference for the only function litdoc exposes.

litdoc()

• title - default 'Documentation'
• markdown - default undefined - overrides markdownPath
• markdownPath - default undefined
• css - default undefined - overrides cssPath
• cssPath - default 'assets/base.css' - litdoc provided
• template - default undefined - overrides templatePath
• this is neat
• templatePath - default 'templates/index.jst' - litdoc provided
• outputPath - default undefined

You must provide either markdown or markdownPath.

litdoc = require('litdoc');

oc({
tle: 'Documentation',
rkdown: undefined,
rkdownPath: undefined,
s: undefined,
sPath: 'assets/base.css', // litdoc provided
mplate: undefined,
mplatePath: 'templates/index.jst', // litdoc provided
tputPath: undefined,