Skip to content

Commit 2741119

Browse files
committed
docs: add guides README
1 parent c4e2c38 commit 2741119

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/en/guides/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Guides
2+
3+
## Getting started
4+
5+
- [Using with Jest](using-with-jest.md)
6+
7+
## Tesing single file components (SFCs)
8+
9+
- [Testing SFCs with Jest](testing-SFCs-with-jest.md)
10+
11+
## Using with plugins
12+
13+
- [Using with Vuex](using-with-vuex.md)

docs/en/guides/using-with-jest.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1+
## Using with Jest
2+
13
Jest and Vue Test Utils work great together.
24

3-
To get started, you need to install Jest and Vue Test Utils:
5+
To get started, we need to install Jest and Vue Test Utils:
46

57
```
68
npm install --save-dev jest vue-test-utils
79
```
810

9-
Inside package.json, create an npm script that runs Jest:
11+
Inside `package.json`, create an npm script that runs Jest:
1012

1113
```
1214
"scripts": {
@@ -37,4 +39,9 @@ And run the tests from the command line:
3739
npm run unit
3840
```
3941

40-
If you want to test .vue files, please see the testing SFCs with Jest guide.
42+
To test .vue files, please see the [testing SFCs with Jest guide](https://github.com/eddyerburgh/vue-test-utils-jest-example).
43+
44+
## Resources
45+
46+
- [Testing SFCs with Jest](testing-SFCs-with-jest.md)
47+
- [Example project with Jest and Vue Test Utils](https://github.com/eddyerburgh/vue-test-utils-jest-example)

0 commit comments

Comments
 (0)