# html-webpack-remark-plugin

> Render Markdown to React through Remark

Latest version **0.3.0** (published 2017-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install html-webpack-remark-plugin
pnpm add html-webpack-remark-plugin
yarn add html-webpack-remark-plugin
bun add html-webpack-remark-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2017-10-02 |
| First published | 2016-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Juho Vepsalainen |
| Maintainers | bebraw |
| Keywords | react, reactjs, remark, remark-react, markdown, highlighting |

## Links

- npm: https://www.npmjs.com/package/html-webpack-remark-plugin
- Repository: https://github.com/bebraw/html-webpack-remark-plugin
- Homepage: https://github.com/bebraw/html-webpack-remark-plugin#readme
- Issues: https://github.com/bebraw/html-webpack-remark-plugin/issues
- npm.io page: https://npm.io/package/html-webpack-remark-plugin

## Dependencies (3)

- [remark](https://npm.io/package/remark.md) ^7.0.0
- [remark-react](https://npm.io/package/remark-react.md) ^4.0.1
- [remark-react-lowlight](https://npm.io/package/remark-react-lowlight.md) ^0.7.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2017-10-02
- 0.2.0 — 2017-10-02
- 0.1.0 — 2016-06-20

## README

# html-webpack-remark-plugin - Render Markdown to React through Remark

This is a plugin for [html-webpack-plugin](https://www.npmjs.com/package/html-webpack-plugin) that allows you to render Markdown through [remark](https://www.npmjs.com/package/remark) and [remark-react](https://www.npmjs.com/package/remark-react) and to inject it into **html-webpack-plugin** template context.

The advantage of doing this is that you'll get HTML out of the box (avoids `dangerouslySetInnerHTML`). This helps with SEO purposes and makes your page load a bit better.

## Usage

```javascript
import HtmlWebpackPlugin from 'html-webpack-plugin';
import HtmlWebpackRemarkPlugin from 'html-webpack-remark-plugin';

// Import custom programming languages for remark to process
import js from 'highlight.js/lib/languages/javascript';

const config = {
  plugins: [
    new HtmlWebpackPlugin({
      title: pkg.name + ' - ' + pkg.description,
      template: 'lib/index_template.ejs',
      inject: false,

      // Context for the template
      name: pkg.name,
      description: pkg.description,
      demonstration: RENDER_UNIVERSAL ? ReactDOM.renderToString(<App />) : ''
    }),
    new HtmlWebpackRemarkPlugin({
      // Key under which to inject the processed file
      key: 'documentation',

      // Markdown file to read and process
      file: path.join(__dirname, 'README.md'),

      // Custom programming languages to process
      languages: {
        js: js
      }
    }),
    ...
  ],
  ...
}
```

## License

MIT.

---
_Source: https://npm.io/package/html-webpack-remark-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._