Skip to content

Commit de0be90

Browse files
committed
Update README
1 parent f2d9bf9 commit de0be90

File tree

1 file changed

+12
-44
lines changed

1 file changed

+12
-44
lines changed

README.md

Lines changed: 12 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,28 @@
11
# markdown-loader
22

3-
markdown-loader for webpack using [marked](https://github.com/markedjs/marked).
3+
**markdown-loader for webpack using [marked](https://github.com/markedjs/marked).**
44

5-
[![](https://img.shields.io/npm/v/markdown-loader.svg)](https://www.npmjs.com/package/markdown-loader)
6-
[![install size](https://badgen.net/packagephobia/install/markdown-loader)](https://packagephobia.now.sh/result?p=markdown-loader)
7-
[![](https://img.shields.io/npm/dm/markdown-loader.svg)](https://www.npmjs.com/package/markdown-loader)
8-
[![Dependency Status](https://david-dm.org/peerigon/markdown-loader.svg)](https://david-dm.org/peerigon/markdown-loader)
9-
[![Build Status](https://travis-ci.org/peerigon/markdown-loader.svg?branch=master)](https://travis-ci.org/peerigon/markdown-loader)
5+
[![Version on NPM](https://img.shields.io/npm/v/markdown-loader?style=for-the-badge)](https://www.npmjs.com/package/markdown-loader)
6+
[![Semantically released](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)
7+
[![Monthly downloads on NPM](https://img.shields.io/npm/dm/markdown-loader?style=for-the-badge)](https://www.npmjs.com/package/markdown-loader)<br>
8+
[![License](https://img.shields.io/npm/l/markdown-loader?style=for-the-badge)](./LICENSE)
109

1110
## Installation
1211

1312
`npm install markdown-loader`
1413

15-
## [Changelog](CHANGELOG.md)
14+
Minimal requirements:
15+
16+
- Node >=12.22.9
17+
- webpack >=5.0.0
1618

1719
## Usage
1820

1921
Since marked's output is HTML, it's best served in conjunction with the [html-loader](https://github.com/webpack/html-loader).
2022

21-
### Webpack 2+
22-
23-
```javascript
24-
{
25-
module: {
26-
rules: [
27-
{
28-
test: /\.md$/,
29-
use: [
30-
{
31-
loader: "html-loader",
32-
},
33-
{
34-
loader: "markdown-loader",
35-
options: {
36-
/* your options here */
37-
},
38-
},
39-
],
40-
},
41-
];
42-
}
43-
}
44-
```
45-
46-
### Options
47-
48-
Pass your marked [options](https://marked.js.org/#/USING_ADVANCED.md#options) as shown above.
49-
In order to specify [custom renderers](https://github.com/peerigon/markdown-loader/issues/5), set the `options.renderer`-option in your webpack config.
50-
5123
```javascript
5224
// webpack.config.js
53-
54-
const marked = require("marked");
55-
const renderer = new marked.Renderer();
56-
57-
module.exports = {
25+
export default {
5826
module: {
5927
rules: [
6028
{
@@ -66,8 +34,8 @@ module.exports = {
6634
{
6735
loader: "markdown-loader",
6836
options: {
69-
pedantic: true,
70-
renderer,
37+
// Pass options to marked
38+
// See https://marked.js.org/using_advanced#options
7139
},
7240
},
7341
],

0 commit comments

Comments
 (0)