# markedjs-extra

> Markdown Extra Plugins for marked. Support footnotes, definitions, checkbox

Latest version **0.0.3** (published 2015-05-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install markedjs-extra
pnpm add markedjs-extra
yarn add markedjs-extra
bun add markedjs-extra
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-05-28 |
| First published | 2015-05-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Tom |
| Maintainers | xiaoliwang |
| Keywords | markdown, node, iojs, requirejs, footnotes, definitions, checkbox |

## Links

- npm: https://www.npmjs.com/package/markedjs-extra
- Repository: https://github.com/xiaoliwang/markedjs-extra
- Homepage: https://github.com/xiaoliwang/markedjs-extra#readme
- Issues: https://github.com/xiaoliwang/markedjs-extra/issues
- npm.io page: https://npm.io/package/markedjs-extra

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2015-05-28
- 0.0.2 — 2015-05-20
- 0.0.1 — 2015-05-19

## README

##markedjs-extra

This repository began as a GitHub fork of [chjj/marked](https://github.com/chjj/marked)
This is a plugins to enable support for Markdown Extra syntax. Open demo/demo.html to try it yourself.

##install

* install with Bower: bower install markedjs-extra --save
* install with npm: npm install marked-extra --save

## Usage

Minimal usage:

```js
var marked = require('marked');
console.log(marked('I am using __markdown__.'));
// Outputs: <p>I am using <strong>markdown</strong>.</p>
```

Example setting options with default values:

```js
var marked = require('marked');
marked.setOptions({
  renderer: new marked.Renderer(),
  gfm: true,
  tables: true,
  extra: true,
  breaks: false,
  pedantic: false,
  sanitize: true,
  smartLists: true,
  smartypants: false
});

console.log(marked('I am using __markdown__.'));
```

### Browser

```html
<!doctype html>
<html>
<head>
  <meta charset="utf-8"/>
  <title>Marked in the browser</title>
  <script src="lib/marked.js"></script>
</head>
<body>
  <div id="content"></div>
  <script>
    document.getElementById('content').innerHTML =
      marked('# Marked in browser\n\nRendered by **marked**.');
  </script>
</body>
</html>
```
more details https://github.com/chjj/marked/blob/master/README.md

##New Feature
(you should set the option extra true)
###checkbox
The following markdown:

```markdown
-[] test
```

will render to something like this depending on how you choose to style it:
<input type="checkbox"> test</input>

###Definition Lists
The following markdown:

```markdown
Term 1
:   Definition 1

Term 2
:   This definition has a code block.

        code block
```

will render to something like this depending on how you choose to style it:
<dl>
  <dt>Term 1</dt>
  <dd>
    Definition 1
  </dd>
  <dt>Term 2</dt>
  <dd>
    This definition has a code block.
    <pre><code>code block</code></pre>
  </dd>
</dl>


##Footnotes
```markdown
Here is a footnote[^footnote].

  [^footnote]: Here is the *text* of the **footnote**.
```

<p>Here is a footnote<a href="#fn:footnote" id="fnref:footnote" title="See footnote" class="footnote">1</a>.</p>

<div class="footnotes">
<hr>
<ol>
<li id="fn:footnote">Here is the <em>text</em> of the <strong>footnote</strong>. <a href="#fnref:footnote" title="Return to article" class="reversefootnote">↩</a></li>
</ol>
</div>

---
_Source: https://npm.io/package/markedjs-extra · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._