https://github.com/uppercod/markdown-inline
https://github.com/uppercod/markdown-inline
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/uppercod/markdown-inline
- Owner: UpperCod
- Created: 2021-03-16T14:47:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-06T23:26:15.000Z (over 4 years ago)
- Last Synced: 2025-03-22T00:44:17.591Z (about 1 year ago)
- Language: JavaScript
- Size: 95.7 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @uppercod/markdown-inline
This package allows the use of markdown thanks to the use of [Template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals), the parser `@uppercod/markdown-inline` transforms the template into tree format created from a createElement type function, example `pragma(tag: string, props: any, ...children: any []):any`, being this friendly with the virtualDOM.
## Install
```
npm install @uppercod/markdown-inline
```
## Usage
```jsx
import { createElement } from "react";
import { setup } from "@uppercod/markdonn";
const md = setup(createElement);
md`
# example
bla bla bla...
**bold**
_italic_
[link](#link)
Custom ${()}
`;
```
## Todo
- [ ] **Nested lists**: The parser generates a tag index that defines the depth of the tag. I have not applied that argument to create nested lists.
- [ ] **Line division**.
- [ ] **Task lists**.