0.0.3 • Published 9 years ago

bartleby v0.0.3

Weekly downloads
8
License
MIT
Repository
github
Last release
9 years ago

bartleby

A next generation documentation site. This combines a lot of DITA-esque ideas with the relative ease of a markup language.

Installation

npm install bartleby

Data concepts

  • config
  • data
  • page

  • Data files are read

  • Config is read
  • Frontmatter is read
  • Liquid is applied to frontmatter

Usage

var bartleby = require('bartleby')

bartleby([{
    source: "spec/fixtures/sample/content/dotcom/articles",
    destination: "_site/articles",
    directory: "spec/fixtures/sample/layouts",
    partials: "spec/fixtures/sample/layouts/includes"
  },
  {
    source: "spec/fixtures/content/post",
    destination: "_site/post",
    directory: "spec/fixtures/sample/layouts",
    partials: "spec/fixtures/sample/layouts/includes"
  }
]);

Returns a Promise.

Options

OptionDescriptionDefault
base
destination
directory
partials
plugins
source

Redirects

Redirect_from array

Redirect_to

Plugins

Relationship

Build information passes down

Watching

is enabled