# @makenowjust/md.html

> Markdown inside HTML

Latest version **0.4.2** (published 2018-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @makenowjust/md.html
pnpm add @makenowjust/md.html
yarn add @makenowjust/md.html
bun add @makenowjust/md.html
```

## 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.4.2 |
| Published | 2018-12-28 |
| First published | 2018-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 5.4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | TSUYUSATO Kitsune |
| Maintainers | makenowjust |

## Links

- npm: https://www.npmjs.com/package/@makenowjust/md.html
- Repository: https://github.com/MakeNowJust/md.html
- Homepage: https://github.com/MakeNowJust/md.html#readme
- Issues: https://github.com/MakeNowJust/md.html/issues
- npm.io page: https://npm.io/package/@makenowjust/md.html

## Dependencies (16)

- [unified](https://npm.io/package/unified.md) ^7.1.0
- [octicons](https://npm.io/package/octicons.md) ^8.2.0
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.1
- [rehype-slug](https://npm.io/package/rehype-slug.md) ^2.0.2
- [remark-math](https://npm.io/package/remark-math.md) ^1.0.5
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.13.1
- [rehype-katex](https://npm.io/package/rehype-katex.md) ^1.2.0
- [remark-emoji](https://npm.io/package/remark-emoji.md) ^2.0.2
- [remark-parse](https://npm.io/package/remark-parse.md) ^6.0.3
- [remark-breaks](https://npm.io/package/remark-breaks.md) ^1.0.2
- [remark-rehype](https://npm.io/package/remark-rehype.md) ^4.0.0
- [rehype-highlight](https://npm.io/package/rehype-highlight.md) ^2.2.1
- [rehype-stringify](https://npm.io/package/rehype-stringify.md) ^5.0.0
- [github-markdown-css](https://npm.io/package/github-markdown-css.md) ^2.10.0
- [remark-external-links](https://npm.io/package/remark-external-links.md) ^3.1.0
- [rehype-autolink-headings](https://npm.io/package/rehype-autolink-headings.md) ^2.0.4

## Recent versions

- 0.4.2 (latest) — 2018-12-28
- 0.4.1 — 2018-12-28
- 0.4.0 — 2018-12-20
- 0.3.0 — 2018-12-17
- 0.2.2 — 2018-12-16
- 0.2.1 — 2018-11-30
- 0.2.0 — 2018-11-30
- 0.1.0 — 2018-11-30

## README

# :memo: md.html <sup>v0.4.2</sup>

> Markdown inside HTML

[![Build Status][travis-badge]][travis] [![NPM version][npm-version-badge]][npm]

Put the following two magical lines into top of HTML file, then you can write Markdown after this and browser renders Markdown automatically.

```markdown
<!doctype html><meta charset="utf-8"><script src="https://unpkg.com/@makenowjust/md.html@0.4.2"></script><noscript>
<!-- vim: set ft=markdown: -->

# Hello `md.html` World!
```

See [md.html demo](https://makenowjust.github.io/md.html/)!<!-- MARKER 1 -->

## Usage

Put the following two magical lines into top of HTML file.

Stable:

```markdown
<!doctype html><meta charset="utf-8"><script src="https://unpkg.com/@makenowjust/md.html@0.4.2"></script><noscript>
<!-- vim: set ft=markdown: -->
```

HEAD:

```markdown
<!doctype html><meta charset="utf-8"><script src="https://makenowjust.github.io/md.html/main.js"></script><noscript>
<!-- vim: set ft=markdown: -->
```

Or, you can get `main.js` from Web and specify this path:

```console
$ curl 'https://makenowjust.github.io/md.html/main.js > docs/main.js
$ cat > docs/index.html
<!doctype html><meta charset="utf-8"><script src="./main.js"></script><noscript>
<!-- vim: set ft=markdown: -->
^D
```

## Features

- Don't need preprocess for publishing Markdown.
- Support footnote reference.
- Render soft breaks as `<br>`.
- Emoji support (e.g. convert `:memo:` to 📝)
- Set `target="_blank"` property to external links.
- Math expression support (inline `$...$` and block `$$⏎...⏎$$`) with [KaTeX][]
- Set slug `id` to `h1-6` tags and append anchor icon.
- Syntax highlighting
- Set title via frontmatter `title` property.
- Correct styles on printing.

**See [examples](examples/)**!

## Development

See [`maidfile.md`](./maidfile.md) tasks.<!-- MARKER 2 -->

## Special Thanks

This project is built with many other packages.

- [remark][] and [unified][] families: Markdown to HTML pipeline
- [github-markdown-css][]: Markdown CSS extracted from GitHub
- [highlight.js][]: syntax highlighting library
- [KaTeX][]: math typesetting library
- [gray-matter][]: frontmatter parser
- [babel][]: JavaScript transpiler
- [webpack][]: JavaScript bundler
- [jest][]: test runner
- [maid][]: Markdown task runner
- [prettier][]: opinionated formatter

and all other dependencies... Thank you!!

## License

MIT (c) 2018 TSUYUSATO "[MakeNowJust][]" Kitsune

<!-- Definitions -->

[travis-badge]: https://img.shields.io/travis/MakeNowJust/md.html/master.svg?style=for-the-badge&logo=travis&colorA=8B6858
[travis]: https://travis-ci.org/MakeNowJust/md.html
[npm-version-badge]: https://img.shields.io/npm/v/@makenowjust/md.html.svg?style=for-the-badge&logo=npm
[npm]: https://www.npmjs.com/package/@makenowjust/md.html
[katex]: https://katex.org/
[remark]: https://remark.js.org/
[unified]: https://unified.js.org/
[github-markdown-css]: https://github.com/sindresorhus/github-markdown-css/
[highlight.js]: https://highlightjs.org/
[gray-matter]: https://github.com/jonschlinkert/gray-matter
[babel]: https://babeljs.io/
[webpack]: https://webpack.js.org/
[jest]: https://jestjs.io/ja/
[maid]: https://github.com/egoist/maid
[makenowjust]: https://github.com/MakeNowJust/
[prettier]: https://prettier.io/
[raw]: https://raw.githubusercontent.com/MakeNowJust/md.html/gh-pages/index.html

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