Skip to content

Commit

Permalink
docs: update commands of E2E section
Browse files Browse the repository at this point in the history
* Document steps to run example

Added a few steps in `readme.md` to install dependencies prior to running the example in the repository.

* Fix badge

* Update README.md

Co-Authored-By: jaskiratr <jaskiratr@gmail.com>

* Example tests docs

Elaborated steps for testing docs in example folder.
  • Loading branch information
jaskiratr authored and Kocal committed Dec 25, 2018
1 parent 229756f commit a54ef9e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,27 @@ Feel free to open an issue/pull request if your template is not supported!

## Testing

### Install Dependencies

```bash
$ git clone https://github.com/Kocal/jsdoc-vuejs
$ cd jsdoc-vuejs
$ yarn install

# For testing the example docs
$ cd example
$ yarn install

# Generate docs for every renderer
$ yarn docs:all

# Generate for a specific renderer
$ yarn docs
$ yarn docs:docstrap
$ yarn docs:minami
$ yarn docs:tui
```

### Unit

```bash
Expand All @@ -139,7 +160,7 @@ you should generate documentation with all renderers:

```bash
$ cd example
$ yarn
$ yarn install
$ yarn docs
$ yarn docs:docstrap
$ yarn docs:minami
Expand Down

0 comments on commit a54ef9e

Please sign in to comment.