# seu-markdown

> Document parser

Latest version **1.0.1** (published 2016-10-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install seu-markdown
pnpm add seu-markdown
yarn add seu-markdown
bun add seu-markdown
```

## 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 | 1.0.1 |
| Published | 2016-10-22 |
| First published | 2016-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| Author | Weiwei SUN |
| Maintainers | wwsun |
| Keywords | markdown, seu |

## Links

- npm: https://www.npmjs.com/package/seu-markdown
- Repository: https://github.com/wwsun/seu-markdown
- Homepage: https://github.com/wwsun/seu-markdown#readme
- Issues: https://github.com/wwsun/seu-markdown/issues
- npm.io page: https://npm.io/package/seu-markdown

## Dependencies (9)

- [lodash](https://npm.io/package/lodash.md) ^4.13.1
- [marked](https://npm.io/package/marked.md) ^0.3.5
- [colorful](https://npm.io/package/colorful.md) ^2.1.0
- [babel-core](https://npm.io/package/babel-core.md) ^6.10.4
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.5.0
- [babel-preset-react](https://npm.io/package/babel-preset-react.md) ^6.11.1
- [babel-preset-es2015](https://npm.io/package/babel-preset-es2015.md) ^6.9.0
- [babel-preset-stage-0](https://npm.io/package/babel-preset-stage-0.md) ^6.5.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

- 1.0.1 (latest) — 2016-10-22
- 1.0.0 — 2016-10-22
- 0.2.2 — 2016-07-18
- 0.2.1 — 2016-07-17
- 0.2.0 — 2016-07-15
- 0.1.0 — 2016-07-12

## README

# seu-markdown

process markdown file via marked

## Usage

`seu-markdown` used to parse markdown documents with `jsx` and `css` codes,
which used to write react demos. The doucment format like:

```markdown
# this is page title            // 文档标题, 也可以写在元信息中: "- title: xxx"

- category: xxx                 // 分类，元信息分类
- ...                           // 其它的元信息

---                             // 元信息分隔线

xxx ooo                         // 文档正文
```

Install `seu-markdown`:

```bash
tnpm install seu-markdown --save
```

Use it to process your markdown file:

```javascript
const smd = require('seu-markdown');
```

## 1.0 API

### `.parse(rawContent)`

Parse documents to document object.

```json
{
  title,
  meta,
  codes,
}
```

### `.render(mdContent)`

Render markdown string to html string.

## 0.2.x API

### `.parse(content)`

解析 markdown 形式的文档。

### `.parseToc(content)`

tbd

### `.md.render`

tdb

### `.md.iframes`

tbd

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