module-docs

KO | EN

gitlite — search

#python #hacktoberfest #golang #deep-learning #docker #nodejs #java #windows #vue #security #pytorch #mcp #ios #open-source

(★ 8)

an npm package that creates a server to browse node module README files

module-docs 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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

![sidebar screen shot](https://raw.githubusercontent.com/ramsaylanier/module-docs/master/assets/images/screen-shot-1.png)
*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:

![sidebar screen shot](https://raw.githubusercontent.com/ramsaylanier/module-docs/master/assets/images/screen-shot-1.png)

module-docs

module-docs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

module-docs

module-docs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README