Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhammadmabrouk/webrouk-markdown-body
Webrouk Markdown Body is a native JavaScript markdown-to-html web component to load and display an external MD file.
https://github.com/muhammadmabrouk/webrouk-markdown-body
js markdown md vanilla web-component
Last synced: about 2 months ago
JSON representation
Webrouk Markdown Body is a native JavaScript markdown-to-html web component to load and display an external MD file.
- Host: GitHub
- URL: https://github.com/muhammadmabrouk/webrouk-markdown-body
- Owner: MuhammadMabrouk
- License: mit
- Created: 2022-11-03T09:37:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-02T18:50:34.000Z (about 2 years ago)
- Last Synced: 2024-11-13T00:49:04.570Z (about 2 months ago)
- Topics: js, markdown, md, vanilla, web-component
- Language: JavaScript
- Homepage:
- Size: 402 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webroukMarkdownBody
Webrouk Markdown Body is a native JavaScript markdown-to-html web component to load and display markdown files.
### Demo
---
[CodePen Example](https://codepen.io/muhammad_mabrouk/full/dyKMgKr/)
### Installation
---
Use [NPM](https://www.npmjs.com/package/webrouk-markdown-body/) to download and install it directly in to your project
```sh
$ npm install webrouk-markdown-body --save
```
or include js file manually
```html
```
### Usage
---
Using webroukMarkdownBody is simple.
```html
```
### Options
| Option | Type | Description | Default |
| ----------- | :----: | ----------- | :----: |
| src | `url` | `path` | Loads and displays an external MD file | `null` |
| default | `# Hello World!` | Default message if there is no content | `null` |
| mode | `light` | `dark` | Chooses the color mode to be applied | `null` |
### Write markdown inline
---
You can pass in your markdown inline too.
```html
- **item one**
- _item two_
- [x] item three
- [Google](https://www.google.com/)
- [YouTube](https://www.youtube.com/)
```
### License
-------
webroukMarkdownBody is licensed [MIT](https://choosealicense.com/licenses/mit/).
It can be used for free and without any attribution, in any personal or commercial project.