Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 7 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,13 @@
# markdown-next
markdown-next parser
# ⚠️ DEPRECATED

[![CircleCI](https://circleci.com/gh/sketchglass/markdown-next.svg?style=svg)](https://circleci.com/gh/sketchglass/markdown-next) [![npm version](https://badge.fury.io/js/markdown-next.svg)](https://badge.fury.io/js/markdown-next)
This repository has been moved to: **[minamorl/markdown-next](https://github.com/minamorl/markdown-next)**

Below is the list of what is supported:
- [x] strong
- [x] em
- [x] p
- [x] headers(h1, h2, h3, h4, h5, h6)
- [x] ul
- [x] ol
- [x] a
- [x] code
- [x] blockquote(nesting is allowed)
- [x] table
- [x] img
Please update your references and use the new repository.

Note: This project is currently beta. Any API will be changed without notice.
---

## Install
Clone this repo and execute `npm run install`.
## このリポジトリは非推奨です

## Basic Usage
新しいリポジトリはこちらです: **[minamorl/markdown-next](https://github.com/minamorl/markdown-next)**

```
const markdown = require("markdown-next")
```

### parse(s: string): string
Returns parsed html string.
This is mostly shorthand of `new Parser({type: asHTML}).parse`.
```
parse(string)
```

### Parser({export: ExportType})

It takes `ExportType` object and make new parser.
Currently, there are two options: `asHTML` and `asAST` which creates HTML and AST respectively

```
const markdown = require("markdown-next")
const parser = new markdown.Parser({
export: markdown.asHTML
})
parser.parse(string)
```

## Test and Development
Run `npm test` command for testing. Under `test` contains unit tests.

## Contribution
Any suggestion or PR is welcome.

## LICENSE
MIT
今後はこちらをご利用ください。
Loading