Skip to content

Commit a54ef9e

Browse files
jaskiratrKocal
authored andcommitted
docs: update commands of E2E section
* 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.
1 parent 229756f commit a54ef9e

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,27 @@ Feel free to open an issue/pull request if your template is not supported!
126126

127127
## Testing
128128

129+
### Install Dependencies
130+
131+
```bash
132+
$ git clone https://github.com/Kocal/jsdoc-vuejs
133+
$ cd jsdoc-vuejs
134+
$ yarn install
135+
136+
# For testing the example docs
137+
$ cd example
138+
$ yarn install
139+
140+
# Generate docs for every renderer
141+
$ yarn docs:all
142+
143+
# Generate for a specific renderer
144+
$ yarn docs
145+
$ yarn docs:docstrap
146+
$ yarn docs:minami
147+
$ yarn docs:tui
148+
```
149+
129150
### Unit
130151

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

140161
```bash
141162
$ cd example
142-
$ yarn
163+
$ yarn install
143164
$ yarn docs
144165
$ yarn docs:docstrap
145166
$ yarn docs:minami

0 commit comments

Comments
 (0)