https://github.com/markpluslabs/markplus-engine
https://github.com/markpluslabs/markplus-engine
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/markpluslabs/markplus-engine
- Owner: markpluslabs
- Created: 2024-10-17T20:54:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-15T23:34:10.000Z (12 months ago)
- Last Synced: 2025-01-16T00:13:38.524Z (12 months ago)
- Language: TypeScript
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MarkPlus Engine
A markdown to html converter with a bunch of extra features.
It powers [react-markplus](https://github.com/markpluslabs/react-markplus).

## Install
```
yarn add markplus-engine
```
## Usage
```ts
import markplusEngine from 'markplus-engine';
const html = await markplusEngine.render('# Hello world!');
```
## Notes
This library focus on markdown to html converstion. It's supposed to run in both Node.js and browser.
Thus, it doesn't handle CSS or client-side JavaScript.(since Node.js doesn't have CSS or client-side JavaScript).