npm/documentation

Stars
369
Rank 115,686 (Top 3 %)
Language MDX
License
Creative Commons ...
Created about 4 years ago
Updated 2 months ago

npm/documentation

npm

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Documentation for the npm registry, website, and command-line interface.

npm Documentation

This is the documentation for https://docs.npmjs.com/.

This repository contains the content for our documentation site, and the GitHub Actions workflows that generate the site itself.

Quick start

npm install to download gatsby, our theme, and the dependencies
npm run develop: starts the test server at http://localhost:8000.
Update the content - it's Mdx, which is like markdown - in the content directory.
Review your content at http://localhost:8000. (Gatsby watches the filesystem and will reload your content changes immediately.)
Once you're happy, commit it and open a pull request at https://github.com/npm/documentation.
A CI workflow run will publish your PR to a GitHub Preview Page.
Once the content is reviewed, merge the pull request. That will deploy the site.

Do you want to know more? Check out our contributing guide.

Theme

The gatsby theme used here is located in the theme/ directory. It is a variation of doctocat with some theme changes for npm's design language and additional components to support multiple versions of the CLI documentation.

License

The npm product documentation in the content, and static folders are licensed under a CC-BY 4.0 license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

npm

This repository is moving to: https://github.com/npm/cli

cli

the package manager for JavaScript

node-semver

The semver parser for node (the one npm uses)

npm-expansions

Send us a pull request by editing expansions.txt

tink

a dependency unwinder for javascript

ini

An ini parser/serializer in JavaScript

npx

npm package executor

rfcs

Public change requests/proposals & ideation

npm-registry-couchapp

couchapp bits of registry.npmjs.org

nopt

Node/npm Option Parsing

registry

npm registry documentation

npmlog

The logger that npm uses

marky-markdown

npm's markdown parser

arborist

npm's tree doctor

pacote

download-counts

Background jobs and a minimal service for collecting and delivering download counts

gauge

A terminal based horizontal guage aka, a progress bar

node-which

Like which(1) unix command. Find the first instance of an executable in the PATH.

init-package-json

A node module to get your node module started

validate-npm-package-name

Is the given string an acceptable npm package name?

cacache

npm's content-addressable cache

npm-merge-driver

git merge driver for resolving conflicts in npm-related files

npm-registry-client

lockfile

A very polite lock file utility, which endeavors to not litter, and to wait patiently for others.

registry-issue-archive

An archive of the old npm registry issue tracker

write-file-atomic

Write files in an atomic fashion w/configurable ownership

read-package-json

The thing npm uses to read package.json files with semantics and defaults and validation and stuff

roadmap

Public roadmap for npm

hosted-git-info

Provides metadata and conversions from repository urls for Github, Bitbucket and Gitlab

fstream

Advanced FS Streaming for Node

make-fetch-happen

making fetch happen for npm

read

read(1) for node.

normalize-package-data

normalizes package metadata, typically found in package.json file.

ndm

ndm allows you to deploy OS-specific service-wrappers directly from npm-packages.

are-we-there-yet

Track complex hiearchies of asynchronous task completion statuses.

abbrev-js

Like ruby's Abbrev module

statusboard

Public monitor/status/health board for @npm/cli-team's maintained projects

security-holder

An npm package that holds a spot.

osenv

Look up environment settings specific to different operating systems.

feedback

Public feedback discussions for npm

npm-registry-fetch

like fetch() but for the npm registry

npm-package-arg

Parse the things that can be arguments to `npm install`

libnpm

programmatic npm API

npm-collection-staff-picks

npm-packlist

Walk through a folder and figure out what goes in an npm package

promzard

A prompting json thingie

npm-remote-ls

Examine a package's dependency graph before you install it

npmconf

npm config thing

cmd-shim

The cmd-shim used in npm

npm-tips

A collection of short (5 words or so) tips and tricks that can be sprinkled about the npm site.

www

community space for the npm website

policies

Privacy policy, code of conduct, license, and other npm legal stuff

package-json

Programmatic API to update package.json

git

a util for spawning git from npm CLI contexts

npm_conf

A conference about npm, maybe. Not to be confused with npmconf.

ignore-walk

Nested/recursive `.gitignore`/`.npmignore` parsing and filtering.

registry-follower-tutorial

write you a registry follower for great good

ssri

subresource integrity for npm

minipass-fetch

An implementation of window.fetch in Node.js using Minipass streams

ci-detect

Detect what kind of CI environment the program is in

run-script

Run a lifecycle script for a package (descendant of npm-lifecycle)

read-installed

Read all the installed packages in a folder, and return a tree structure with all the data.

mute-stream

Bytes go in, but they don't come out (when muted).

fs-write-stream-atomic

Like `fs.createWriteStream(...)`, but atomic.

read-package-json-fast

Like read-package-json, but faster

libnpmpublish

programmatically publish and unpublish npm packages

logical-tree

Calculates a nested logical tree using a package.json and a package lock.

read-package-tree

Read the contents of node_modules

jobs

unique-filename

Generate a unique filename for use in temporary directories or caches.

lock-verify

Report if your package.json is out of sync with your package-lock.json

fstream-ignore

benchmarks

The npm CLI's benchmark suite

npm-lifecycle

npm lifecycle script runner

wombat-cli

The wombat cli tool.

npme-installer

npm Enterprise installer

couch-login

A module for doing logged-in requests against a couchdb server

libnpmexec

npm exec (npx) Programmatic API

npm-audit-report

npm audit security report

ansible-nagios

Ansible role for building Nagios 4.

config

Configuration management for https://github.com/npm/cli

parse-conflict-json

Parse a JSON string that has git merge conflicts, resolving if possible

npm-profile

Make changes to your npmjs.com profile via cli or library

unique-slug

Generate a unique character string suitible for use in files and URLs.

fstream-npm

fstream class for creating npm packages

redsess

Yet another redis session thing for node.

concurrent-couch-follower

a couch follower wrapper that you can use to be sure you don't miss any documents even if you process them asynchronously.

npm-registry-mock

mock the npm registry

lint

lint the npmcli way

fs

filesystem helper functions, wrappers, and promisification for the npm cli

template-oss

a template package for npm CLI team development

libnpmsearch

programmatic API for the shiny new npm search endpoint

bin-links

.bin/ script linker

libnpmaccess

programmatic api for `npm access`

logos

official logos for npm, Inc

types

Typescript definitions for npm registry content

public-api

deprecate-holder

An npm package that holds a spot.

map-workspaces

Retrieves a name:pathname Map for a given workspaces config

libnpmversion

library to do the things that 'npm version' does