This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
famous-doc-generator with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
npm install famous-doc-generator
or if you would like to install from source
git clone firstname.lastname@example.org:Famous/famous-doc-generator.git cd doc-generator npm link
famous-doc-generator --base=[path] The directory to start searching from --out=[path] The directory where the compiled templates will write to. --ignore=[paths **OPTIONAL**] Add a directory nested underneath the base directory to ignore. --outData=[path **OPTIONAL**] Path where the json data will be saved. Useful to debug templates --pathPrefix=[path **OPTIONAL**] All asset pathing will get this prefix. --headerTemplate=[path **OPTIONAL**] Header partial to include. --footerTemplate=[path **OPTIONAL**] Footer partial to include. --template=[path **OPTIONAL**] Path to a complete custom template. This template will be run against every file found. --markdown [**OPTIONAL**] Output markdown instead of html. --createIndex [**OPTIONAL**] Create an index.html file in the root of the output directory. --createPartials [**OPTIONAL**] Compile html partials to the output directory. Usefull for consumption by another templating system.
Ignoring multiple directories
famous-doc-generator --base=./lib --ignore=./lib/famous --ignore=./lib/famous/core
Q. My file isn't showing up in the documentation! A. YUIDoc is very picky about what it chooses to parse as comments. Make sure that your comments start with
/** * * */
Note the double ** before every comment.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.