Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 637 Bytes

README.md

File metadata and controls

31 lines (25 loc) · 637 Bytes

meteor-collection-autodoc

A command-line script that runs alongside a Meteor app during development to help you generate docs for collection schemas, on the fly.

Installation:

Alias the coldoc script:

alias coldoc="/absolute/path/to/coldoc"

Usage:

Unless you pass a file path, you should run this from the root directory of your Meteor app; i.e. the parent directory of /lib.

Show docs for one collection:

coldoc Admins

Show docs for all collections:

coldoc

Show docs for all collections starting with "A":

coldoc A

Show docs for a particular file:

coldoc /my/js/directory/file.js