Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kocal committed Dec 25, 2018
1 parent a54ef9e commit e143554
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,18 @@ $ yarn install
# For testing the example docs
$ cd example
$ yarn install
```

#### Generate documentations

```bash
$ cd example

# Generate docs for every renderer
$ yarn docs:all

# Generate for a specific renderer
$ yarn docs
# or one by one
$ yarn docs # default jsdoc template
$ yarn docs:docstrap
$ yarn docs:minami
$ yarn docs:tui
Expand All @@ -160,17 +166,13 @@ you should generate documentation with all renderers:

```bash
$ cd example
$ yarn install
$ yarn docs
$ yarn docs:docstrap
$ yarn docs:minami
$ yarn docs:tui
$ cd ..
$ yarn docs:all
```

And then run Cypress:

```bash
$ cd ..
$ yarn cypress run
```

Expand Down

0 comments on commit e143554

Please sign in to comment.