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

masterdoc

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

masterdoc

Help you write a well-formed project documentation.

  • 0.1.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

masterdoc

Help you write a well-formed project documentation.

Latest stable version: v0.1.0


Installation

$ npm install masterdoc -g

Usage

Simple project

It only needs a single-page doc.

# Generate a "README.md" template in CWD
$ masterdoc
Complex project

It may has multiple modules, often needs an extra project to place the docs.

# Generate a set of structured doc templates in CWD
$ masterdoc -c

Please perfect the content according to the templates, you can add or delete any stuff as you like.

The most important things for docs

  1. Clear index and structure.
  2. Carefully prepared demo.
  3. The less the better.

Licence

MIT

Keywords

FAQs

Package last updated on 07 Nov 2014

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