Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacques/docs.npmjs.com
The place where all the docs will live one day.
https://github.com/jacques/docs.npmjs.com
Last synced: 3 days ago
JSON representation
The place where all the docs will live one day.
- Host: GitHub
- URL: https://github.com/jacques/docs.npmjs.com
- Owner: jacques
- Created: 2014-09-24T12:40:51.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-04-12T18:29:48.000Z (over 2 years ago)
- Last Synced: 2024-11-07T02:44:20.820Z (10 days ago)
- Language: JavaScript
- Size: 12.9 MB
- Stars: 5
- Watchers: 3
- Forks: 507
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [docs.npmjs.com](https://docs.npmjs.com)
Learn you some npm for great good.
[](https://travis-ci.org/npm/docs)
[](https://codeclimate.com/github/npm/docs)
[](https://david-dm.org/npm/docs)
## Editing Content
All the markdown files can be found in the [content](content) directory. Some of these files live here in this repository, others live in other repositories and are imported during the build process. These imported files are [ignored by git](.gitignore) to prevent people from accidentally editing the wrong files.
### In this repo
- [Getting Started](content/getting-started)
- [How npm Works](content/how-npm-works)
- [Private Modules](content/private-modules)
- [Organizations](content/orgs)
### Copied from npm/npm
- [CLI commands](https://github.com/npm/npm/tree/master/doc/cli)
- [Configuring npm](https://github.com/npm/npm/tree/master/doc/files)
- [Using npm](https://github.com/npm/npm/tree/master/doc/misc)
## HTML Frontmatter for Page Metadata
This site uses [html-frontmatter](https://www.npmjs.org/package/html-frontmatter) to add
metadata to pages.
### title
If a file has a `title` property in its frontmatter, it will be used for
the `` of the rendered HTML page. If `title` is absent from the
frontmatter, the filename (without the .md extension) is used.
### order
Pages are sorted alphabetically by default, but the page order per section
can be overridden by using a numerical `order` frontmatter property. It is
not necessary to order all pages in a section: Any pages in a section that
don't have an `order` property will be relegated to the end of that section.
## Redirects
If you rename or remove a file, add it to [lib/redirects.js](lib/redirects.js) to keep
things from breaking.
## Sections
If you rename a directory inside the `content` directory, you'll need to change it in [sections.json](/sections.json) to allow the [content.json](/content.json) to pick up the changes.
## Development
Download Node at [nodejs.org](https://nodejs.org) and install it, if you haven't already.
To run the app locally:
```sh
npm install
npm run dev
```
Now you have a server running [nodemon](https://www.npmjs.com/package/nodemon) at [localhost:5000](http://localhost:5000).
NOTE: If you are using `iojs`, or Node versions 4 or 5 on a Linux or OSX box,
you will need to do the following steps:
```
$ sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
$ sudo apt-get update -qq
$ sudo apt-get install -qq -y g++-4.8
$ sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.8 50
```
NOTE: If you have changed Node.js versions and are still getting
and error on a supported version of Node.js, you may need to rebuild npm:
```
$ npm rebuild
```
## The Build Process
The build is run automatically after every `npm install` and before `npm start`. Here's an overview of what it does:
1. Copies [npm documentation](https://github.com/npm/npm/tree/master/doc) from `./node_modules/npm/doc` to `./content`.
1. Walks the [content directory](/content) collecting markdown files.
1. Reads the contents of each markdown file.
1. Parses [HTML Frontmatter](#html-frontmatter) from the markdown files.
1. Converts markdown to HTML.
1. Writes [content.json](/content.json) with HTML content of each file included.
The copied and generated files are [ignored](/.gitignore) for two reasons:
1. Keeps the git history uncluttered.
1. Prevents humans from accidentally editing auto-generated files.
## Webservice
The [content.json](/content.json) file is served publicly at `/content.json`
with CORS support, allowing browsers on other domains to fetch all the npm
documentation and accompanying metadata with a single HTTP call.
## Tests
```sh
npm install
npm test
```
[](https://github.com/feross/standard)
## Deployment
```sh
git push origin +master:deploy-staging
git push origin +master:deploy-production
```
If you get dissed with an "Everything up-to-date" message, make an empty commit and push again:
```
git commit -avm "emptiness" --allow-empty
```