# ray-md-loader

> personal webpack markdown loader

Latest version **2.1.1** (published 2023-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install ray-md-loader
pnpm add ray-md-loader
yarn add ray-md-loader
bun add ray-md-loader
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2023-11-03 |
| First published | 2021-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ilex.h |
| Maintainers | ilex.h |
| Keywords | doc, md |

## Links

- npm: https://www.npmjs.com/package/ray-md-loader
- npm.io page: https://npm.io/package/ray-md-loader

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^4.3.0
- [loader-utils](https://npm.io/package/loader-utils.md) ^1.4.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 2.1.1 (latest) — 2023-11-03
- 2.1.0 — 2023-11-03
- 2.0.1 — 2021-06-13
- 2.0.0 — 2021-06-13
- 1.0.1 — 2021-06-13
- 1.0.0 — 2021-06-13

## README

# ray-md-loader

## author

ilex.h

## useage

### webpack@1.x use ray-md-loader v1

```js

// webpack.config.js

{
  module: {
    loaders: [
      { test: /\.md?$/, loader: 'ray-md-loader' }
    ]
  },
  rayMdLoader: {
    highlight: (code, lang) => codeBeautify(code, lang)
  }
}


// or

{
  module: {
    loaders: [
      { test: /\.md?$/, loader: 'ray-md-loader', query: { config: 'testMdLoader' } }
    ]
  },
  testMdLoader: {
    highlight: (code, lang) => codeBeautify(code, lang)
  }
}

```

### webpack@2/webpack@3+ use ray-md-loader v2

```js
const rayDocRender = require('ray-doc-render');

{
  module: {
    rules: [
      { test: /\.md?$/, use: [
        {
          loader: 'ray-md-loader',
          options: {
            highlight: (code, lang) => codeBeauty(code, lang),
            renderer: rayDocRender.customRender
          }
        }
      ] }
    ]
  },
}

```

options 可配置项：

* `renderer` renderer 存放的是一个对象，不声明时默认为`new marked.Renderer()`.
* `gfm` 允许 Git Hub标准的markdown，默认为true。
* `tables` 允许支持表格语法，默认为true。该选项要求 gfm 为true。
* `breaks` 允许回车换行，默认为false。该选项要求 gfm 为true。 **ray-md-loader** 中默认设置为 false
* `pedantic` 尽可能地兼容 markdown.pl的晦涩部分。不纠正原始模型任何的不良行为和错误。默认为false。
* `sanitize` 对输出进行过滤（清理），将忽略任何已经输入的html代码（标签），默认为false。
* `smartLists` 使用比原生markdown更时髦的列表。 旧的列表将可能被作为pedantic的处理内容过滤掉。默认为false。**ray-md-loader** 中默认设置为 true
* `smartypants` 使用更为时髦的标点，比如在引用语法中加入破折号。默认为false

## License

MIT

---
_Source: https://npm.io/package/ray-md-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._