docme

v0.3.0

Generates github compatible API documentation from your project's jsdocs and adds them to your Readme. For more information about how to use this package see README

Latest version published 10 years ago

License: MIT

NPM

GitHub

Package Health Score

39 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.3.0	\|	04/2015	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.1	\|	03/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.6	\|	03/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.2	\|	12/2013		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (1)

GitHub Stars: 55
Forks: 5
Contributors: -

Direct Usage Popularity

The npm package docme receives a total of 1 downloads a week. As such, we scored docme popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package docme, we found that it has been starred 55 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like docme is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 1
Open PR: 0
Last Release: 10 years ago
Last Commit: 10 years ago

Further analysis of the maintenance status of docme based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for docme is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 11 years
Dependencies: 12 Direct
Versions: 13
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

docme has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

docme

Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.

Installation

npm install docme

Usage

docme   -- 

  Generates jsdocs for non-private members of the project in the current folder.
  It then updates the given README with the githubified version of the generated API docs.

  Note: overriding the jsdoc destination (-d, --destination) is not possible since docme will write files to a temp dir

OPTIONS:

  -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
  
  -h, --help      Print this help message.

EXAMPLES:
  
  Generate with default options and update README.md
    
    docme README.md

  Override [jsdocconf.json](https://usejsdoc.org/about-configuring-jsdoc.html):

    docme README.md -- --configure ./myconf.json

  Override loglevel and jsoc configuration:

    docme API.md --loglevel silly -- --configure ./myconf.json

Note: all functions that are not part of the public API should be marked as @private in order to exclude them from the docs generated by docme.

Helpful links

Since docme is using jsdoc under the hood, it is helpful to review its documentation. I highly recommend this page explaining how to specify @param types among other useful specs.

In order to make your docme APIs appear properly styled, please install the chrome extension or bookmarklet.

API

docme(readme, args, jsdocargs, cb)

Generates jsdocs for non-private members of the project in the current folder. It then updates the given README with the githubified version of the generated API docs.

Parameters:

Name Type Description

readme

String

path to readme in which the API docs should be updated

args

Array.<String>

consumed by docme

Properties

Name	Type	Argument	Description
`loglevel`	String	<optional>	(info) level at which to log: silly\|verbose\|info\|warn\|error\|silent

jsdocargs

Array.<String>

consumed by jsdoc

cb

function

called back when docme finished updating the README

Source:

index.js , lineno 54

generated with docme

License

MIT

docme dependencies

jsdoc jsdoc-githubify minimist mutiny npmlog prune-html readable-stream rimraf runnel through2 transformify update-section

docme development dependencies

nave tap

FAQs

What is docme?

Generates github compatible API documentation from your project's jsdocs and adds them to your Readme. Visit Snyk Advisor to see a full health score report for docme, including popularity, security, maintenance & community analysis.

Is docme popular?

The npm package docme receives a total of 1 weekly downloads. As such, docme popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is docme well maintained?

We found indications that docme is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is docme safe to use?

While scanning the latest version of docme, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 October-2024, at 13:56 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

docme

Installation

Usage

Helpful links

API

docme(readme, args, jsdocargs, cb)

Parameters:

Properties

License

docme dependencies

docme development dependencies

FAQs

What is docme?

Is docme popular?

Is docme well maintained?

Is docme safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues