https://github.com/ramsaylanier/module-docs
an npm package that creates a server to browse node module README files
https://github.com/ramsaylanier/module-docs
Last synced: 4 months ago
JSON representation
an npm package that creates a server to browse node module README files
- Host: GitHub
- URL: https://github.com/ramsaylanier/module-docs
- Owner: ramsaylanier
- Created: 2019-01-12T15:57:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T03:54:46.000Z (over 7 years ago)
- Last Synced: 2025-08-09T11:19:56.474Z (10 months ago)
- Language: JavaScript
- Size: 554 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Module Docs
an NPM package that creates a local server so you can browse README files of dependecies included in your applications `node_modules` directory
*Example screenshot*
## Installation
```bash
yarn add module-docs
```
## Setup
To add module-docs to your application, you can:
Create an npm script in your applications `package.json` file that can run it.
```json
...
"scripts": {
"start:docs": "module-docs start"
}
...
```
Or run it manually from the root directory of your application:
```bash
npx run module-docs start
```
## Config
Create a `module-docs.config.js` file in the root of your application.
### Adding favorites
You can add favorites to the sidebar of the module-docs application like so:
```js
// module-docs.config.js
module.exports = {
favorites: ["react", "react-apollo", "react-apollo-hooks"]
}
```
Which will result in the sidebar looking like this:
