https://github.com/tylingsoft/markdown-core

An extensible markdown engine which powers Markdown Plus.
https://github.com/tylingsoft/markdown-core

markdown markdown-core markdown-plus mdc

Last synced: 3 months ago
JSON representation

An extensible markdown engine which powers Markdown Plus.

• Host: GitHub
• URL: https://github.com/tylingsoft/markdown-core
• Owner: tylingsoft
• Created: 2015-11-02T12:43:57.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-12-26T14:18:55.000Z (almost 7 years ago)
• Last Synced: 2024-07-12T22:55:18.516Z (4 months ago)
• Topics: markdown, markdown-core, markdown-plus, mdc
• Language: JavaScript
• Homepage:
• Size: 12.1 MB
• Stars: 35
• Watchers: 6
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown Core

[![Code Climate](https://codeclimate.com/github/tylingsoft/markdown-core.png)](https://codeclimate.com/github/tylingsoft/markdown-core)

An extensible markdown engine used in the [Markdown Plus](https://github.com/tylingsoft/markdown-plus) project.

## Installation

```

yarn add markdown-core

```

## Usage

### Node.js

```js

import mdc from 'markdown-core'

mdc.render('# hello world')

```

### Browser

Please refer to [the example](./build).

## Development

### Build

```

yarn build:watch

```

### Verify

Host and open `build/index.html` in browser

## License

MIT

---

## Test

1. Manually review `build/index.html` in browser, make sure it look good and everything is fine.

2. In `test/index.js` set `const init = true`.

3. Run `yarn test` to generate fixtures in `test/fixtures`.

4. In `test/index.js` set `const init = false`.

5. Do development, change code.

6. Run `yarn test` to make sure nothing breaks.

## Todo

- PPT

- Create a website for this project

    - GitHub pages

- `mdc.xxx` => `xxx`

- Support mermaid git graph

- Replace mocha with jest