Skip to content

Commit 5fb4a00

Browse files
authored
Merge pull request #6 from ezrafree/readme-updates
Add improvements to the README document
2 parents a0470ec + 97b8ca3 commit 5fb4a00

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[简体中文](./README-CN.md)
44

5-
This is a webpack laoder that can load markdown file. With proper configuration, the loader can convert markdown file content into `vue sfc` component object or into html string, so it can be chained with vue-loader or html-loader.
5+
This is a webpack loader that can load markdown files. With proper configuration, the loader can convert markdown file content into `vue sfc` component object or into html string, so it can be chained with vue-loader or html-loader.
66

77
The project is inspired by [vuepress](https://github.com/vuejs/vuepress), we reused most of its source code and made some improvements to allow it being used in non-vuepress project.
88

@@ -16,9 +16,9 @@ If you are interested in Vuepress, please visit [vuepress](https://github.com/vu
1616
npm i @tianyong90/vue-markdown-loader -S
1717
```
1818

19-
## Useage
19+
## Usage
2020

21-
### sue along with vue-loader
21+
### Use along with vue-loader
2222

2323
Generally, it is recommended to be used with `vue-loader`
2424

@@ -80,7 +80,7 @@ export default {
8080
</style>
8181
```
8282
83-
### along with html-loader
83+
### Use along with html-loader
8484
8585
`vue-markdown-loader` can parse markdown and return html string which can be loaded by `html-loader`
8686
@@ -126,13 +126,13 @@ Hello:
126126
127127
![加载后的 html](./images/md-html-string.png)
128128
129-
### use it alone
129+
### Use it alone
130130
131-
`vue-markdown-loader` can parse markdown file and return an object whick contains hteml and frontmattter data of the file.
131+
`vue-markdown-loader` can parse markdown file and return an object which contains html and frontmattter data of the file.
132132
133133
1. configuration
134134
135-
add rule for .md file in webpack.config.js
135+
add rule for `.md` file in webpack.config.js
136136
137137
```js
138138
module: {
@@ -166,7 +166,7 @@ import Hello from 'hello.md'
166166
console.log(Hello)
167167
```
168168
169-
the variable `Html` contains 2 property, `attributes`(frontmatter data) and `html`(html content), looks lick below:
169+
the variable `Html` contains 2 property, `attributes`(frontmatter data) and `html`(html content), looks like below:
170170
171171
![加载后的对象](./images/md-raw-object.png)
172172

0 commit comments

Comments
 (0)