Skip to content

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

Notifications You must be signed in to change notification settings

FitMango/meteor-collection-autodoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

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

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages