# markdown-core

**Repository Path**: dazdata-bi/markdown-core

## Basic Information

- **Project Name**: markdown-core
- **Description**: fork from https://github.com/tylingsoft/markdown-core
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-09
- **Last Updated**: 2024-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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