# markdown-element
**Repository Path**: mirrors_mikeal/markdown-element
## Basic Information
- **Project Name**: markdown-element
- **Description**: HTML Element that renders markdown content.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-07-18
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Markdown Element
HTML Element for markdown content.
Usage:
```html
## h2
* test
* test2
```javascript
let x = 'asdf'
class Text {
constructor() {
}
}
```
```
## Attributes/properties
The following element properties can be used to change the render settings. They can be set either from JavaScript or from HTML.
* **noGFM**: Disables GitHub flavored markdown (GFM).
* **noTables**: Disables GFM tables. This has no effect if `noGFM` is true.
* **breaks**: Enable GFM line breaks. This has no effect if `noGFM` is true.
* **noHighlight**: Disables syntax highlighting.
* **pedantic**: Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
* **noSmartLists**: Disable smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.
* **smartyPants**: Use "smart" typographic punctuation for things like quotes and dashes.
Examples:
```html
# h1
* test
```
```js
let marked = document.createElement('mark-down')
marked.noGFM = true
marked.smartyPants = true
document.body.appendChild(marked)
```
## Rendering
The rendered markdown is placed in a `` element.
```html
h1
```
### Bundling
If you want to build the component into the JavaScript bundle of your app
you can do so easily, but you'll need to handle loading a WebComponents
polyfill on your own.