Skip to content

Commit e143554

Browse files
authored
Update README.md
1 parent a54ef9e commit e143554

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,18 @@ $ yarn install
136136
# For testing the example docs
137137
$ cd example
138138
$ yarn install
139+
```
140+
141+
#### Generate documentations
142+
143+
```bash
144+
$ cd example
139145

140146
# Generate docs for every renderer
141147
$ yarn docs:all
142148

143-
# Generate for a specific renderer
144-
$ yarn docs
149+
# or one by one
150+
$ yarn docs # default jsdoc template
145151
$ yarn docs:docstrap
146152
$ yarn docs:minami
147153
$ yarn docs:tui
@@ -160,17 +166,13 @@ you should generate documentation with all renderers:
160166

161167
```bash
162168
$ cd example
163-
$ yarn install
164-
$ yarn docs
165-
$ yarn docs:docstrap
166-
$ yarn docs:minami
167-
$ yarn docs:tui
168-
$ cd ..
169+
$ yarn docs:all
169170
```
170171

171172
And then run Cypress:
172173

173174
```bash
175+
$ cd ..
174176
$ yarn cypress run
175177
```
176178

0 commit comments

Comments
 (0)