Skip to content

Commit

Permalink
Merge pull request #94 from ankitkumar-zop/patch-1
Browse files Browse the repository at this point in the history
Chore: update readme
  • Loading branch information
ankitskvmdam authored Dec 4, 2021
2 parents cca3bcf + a9e125c commit 7bc0dc3
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ For any suggestions, questions or bugs, feel free to create an <a href="https://
## Motivation

When I was new to JavaScript documentation and [JSDoc](https://jsdoc.app/), it was hard for me to find a theme for JSDoc which was highly customizable or regularly maintained. Features that these lacked included responsiveness, a working search bar, and customization.
To tackle these problems I created this project, an easy to use, responsive theme for JSDoc. I am actively working on this project and I try to make changes to the project frequently to make sure it's up to date, and suggestions and bugs are fixed.
To tackle these problems I created this project, an easy to use, responsive theme for JSDoc. I am actively working on this project and I try to make changes to the project frequently to make sure it's up to date.

## Installation

Expand All @@ -49,21 +49,11 @@ On your command line type
npm install clean-jsdoc-theme
```

## Usage

Clone repository to your designated JSDoc template directory, then run the following command:

```bash
jsdoc entry-file.js -t path/to/clean-jsdoc-theme
```

## Node.js Dependency

In your projects `package.json` file add a generate script

```json
"script": {
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
"generate-docs": "node_modules/.bin/jsdoc --configure jsdoc.json --verbose"
}
```

Expand All @@ -75,6 +65,12 @@ In your `jsdoc.json` file, add a template option.
}
```

Now to generate docs run
```bash
npm run generate-docs
```
For more information look at [https://github.com/ankitskvmdam/clean-jsdoc-theme-example](https://github.com/ankitskvmdam/clean-jsdoc-theme-example)

## Example JSDoc Config

```json
Expand Down

0 comments on commit 7bc0dc3

Please sign in to comment.