Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mojito-cli-doc

Package Overview
Dependencies
Maintainers
6
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mojito-cli-doc

Provide the `doc` command, to generate API docs, for `mojito-cli`

  • 0.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
6
Weekly downloads
 
Created
Source

mojito-cli-doc

Build Status

mojito-cli-docs provides the doc command for mojito-cli, that you can install with: npm install -g mojito-cli.

The doc command generates, or serves, API documentation for Mojito, Mojito apps, or mojits.

npm install -g mojito-cli

Usage

To generate documentation for a mojito application, including all the mojits in it's mojits/ subdirectory, run the following from the application directory:

$ mojito docs app [name]

Optional name if provided, is used as the sub-directory name to save the generated API docs. See Options below.

To generate documentation for a specific mojit, run the following from the application directory:

$ mojito docs mojit <mojit-name>

To generate documentation for the Mojito framework itself:

$ mojito docs mojito

Options

Specify output directory (if --port or --server are not used):

--directory <path>
-d <path>

By default, the generated files are saved in ./artifacts/docs/, or if a name argument is provided, ./artifacts/docs/<name>.

Exclude some files or directories from being processed:

--exclude <pattern>
-e <pattern>

This option can be repeated, for example mojito doc --exclude middleware --exclude build will exclude files or directories with "middleware" or "build" in their names.

Serve the API docs over HTTP, without rendering them to the file system (assumes --port 3000):

--server
-s

Serve the API docs over HTTP, like option --server, using the specified port number:

--port <number>
-p <number>

Discussion/Forums

http://developer.yahoo.com/forum/Yahoo-Mojito

Licensing and Contributions

mojito-cli-doc is licensed under a BSD license (see LICENSE.txt). To contribute to the Mojito project, please see Contributing.

The Mojito project is a meritocratic, consensus-based community project, which allows anyone to contribute and gain additional responsibilities.

Keywords

FAQs

Package last updated on 19 Nov 2013

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc