makdoc

a static document generator

npm install makdoc
2 downloads in the last week
8 downloads in the last month

makdoc

A static document generator, mainly inspired by docpad

Getting Started

Install the module with: npm install makdoc --save-dev

If you use cli install makdoc to global scope with -g option.

.
└── src
  └── docs
    ├── documents
    ├── layouts
    └── partials

Directories is found from current working directory. When you use makdoc as a standlone, current working directory will be return of shell commend 'pwd'

  • src/docs/documents : content to read
  • src/docs/layouts : template to beautify documents
  • src/docs/partials : reuseable code piece. It is injected to any position in layout and document

To use as a library

  makdoc = new Makdoc options
  makdoc.progress()

To use as standlone

  $ makdoc

Options

  • src: This indecate source directory of documents.
  • out: This is target directory that result after makdoc rendering.
  • documents.cwd: Document directory.
  • documents.files: Document file pattern.
  • layouts.cwd: Layout directory.
  • layouts.files: Layout file pattern.
  • partials.cwd: Partial directory.
  • partials.files: Partial file pattern.

Refer official site for more detail about Makdoc

Buff

Makdoc capability is extended with the buff. Buff is same as plugin that can commonly see at other systems. Check out the following buffs.

Examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2013+ Makdoc Licensed under the MIT license.

npm loves you