https://github.com/peerigon/markdown-loader

markdown loader for webpack
https://github.com/peerigon/markdown-loader

html javascript loader markdown marked webpack webpack-loader

Last synced: 5 months ago
JSON representation

markdown loader for webpack

• Host: GitHub
• URL: https://github.com/peerigon/markdown-loader
• Owner: peerigon
• License: mit
• Created: 2014-07-15T17:00:05.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-07-27T10:59:57.000Z (9 months ago)
• Last Synced: 2024-09-08T13:44:13.395Z (7 months ago)
• Topics: html, javascript, loader, markdown, marked, webpack, webpack-loader
• Language: JavaScript
• Homepage:
• Size: 1.88 MB
• Stars: 375
• Watchers: 15
• Forks: 70
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - markdown-loader

README

        
# markdown-loader

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

[![Version on NPM](https://img.shields.io/npm/v/markdown-loader?style=for-the-badge)](https://www.npmjs.com/package/markdown-loader)

[![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)

[![Monthly downloads on NPM](https://img.shields.io/npm/dm/markdown-loader?style=for-the-badge)](https://www.npmjs.com/package/markdown-loader)


[![License](https://img.shields.io/npm/l/markdown-loader?style=for-the-badge)](./LICENSE)

## Installation

`npm install markdown-loader`

Minimal requirements:

- Node >=12.22.9

- webpack >=5.0.0

## Usage

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

```javascript

// webpack.config.js

export default {

  module: {

    rules: [

      {

        test: /\.md$/,

        use: [

          {

            loader: "html-loader",

          },

          {

            loader: "markdown-loader",

            options: {

              // Pass options to marked

              // See https://marked.js.org/using_advanced#options

            },

          },

        ],

      },

    ],

  },

};

```

## License

MIT (http://www.opensource.org/licenses/mit-license.php)

## Sponsors

[](https://peerigon.com)