Migrate to djot

posthtml-djot/README.md

@@ -0,0 +1,230 @@
+<div align="center">
+  <img width="150" height="150" title="PostHTML" src="https://posthtml.github.io/posthtml/logo.svg">
+  <h1>posthtml-markdownit</h1>
+  
+  Transform Markdown to HTML
+
+  [![Version][npm-version-shield]][npm]
+  [![Build][github-ci-shield]][github-ci]
+  [![License][license-shield]][license]
+  [![Downloads][npm-stats-shield]][npm-stats]
+</div>
+
+## Introduction
+
+This PostHTML plugin compiles Markdown to HTML using [markdown-it](https://github.com/markdown-it/markdown-it).
+
+Before:
+
+```xml
+<markdown>
+  # Heading 1
+  ---
+
+  Paragraph with some text
+
+  _Italic_
+  **Bold**
+
+  - List item 1
+  - List item 2
+  - List item 3
+</markdown>
+```
+
+After:
+
+```html
+<h1>Heading 1</h1>
+<hr>
+<p>Paragraph with some text</p>
+<p>
+  <em>Italic</em>
+  <strong>Bold</strong>
+</p>
+<ul>
+  <li>List item 1</li>
+  <li>List item 2</li>
+  <li>List item 3</li>
+</ul>
+```
+
+## Install
+
+```
+npm i -D posthtml posthtml-markdownit
+```
+
+## Usage
+
+```js
+import posthtml from 'posthtml'
+import markdown from 'posthtml-markdownit'
+
+posthtml([
+  markdown()
+])
+  .process('<markdown># Test</markdown>')
+  .then(result => console.log(result.html))
+
+// <h1>Test</h1>
+```
+
+### Importing files
+
+You can import and render Markdown files:
+
+Before:
+
+```xml
+<markdown src="./README.md">
+  # Imported
+</markdown>
+```
+
+After:
+
+```html
+<!-- Here be the contents of README.md, as HTML -->
+<h1>Imported</h1>
+```
+
+## Syntax
+
+### Tags
+
+Both `<markdown>` and `<md>` tags are supported.
+
+Before:
+
+```xml
+<md>
+  # Heading 1
+</md>
+```
+
+After:
+
+```html
+<h1>Heading 1</h1>
+```
+
+By default, the custom tags like `<md>` are replaced with the compiled Markdown. See the [tag attribute](#tag) if you need a wrapping tag around your Markdown content.
+
+### Attributes
+
+You can also use the `markdown` or `md` attributes on an HTML element:
+
+Before:
+
+```html
+<div md>
+  # Heading 1
+</div>
+```
+
+After:
+
+```html
+<h1>Heading 1</h1>
+```
+
+#### `tag`
+
+You can use a `tag` attribute to wrap the resulting markup in a tag:
+
+Before:
+
+```xml
+<md tag="section">
+  # Heading 1
+</md>
+```
+
+After:
+
+```html
+<section>
+  <h1>Heading 1</h1>
+</section>
+```
+
+#### `inline`
+
+You can mark the content to be rendered inline. This is helpful if you're including a file that will be used as an inline element and don't want the enclosing `p` tags.
+
+Before:
+
+```xml
+<div class="example">
+  <markdown src="./example.md" inline>
+    Imported
+  </markdown>
+</div>
+```
+
+After:
+
+```html
+<p class="example">Imported</p>
+```
+
+Instead of:
+
+```html
+<div class="example">
+  <p>Imported</p>
+</div>
+```
+
+## Options
+
+### `root`
+
+Type: `string`\
+Default: `./`
+
+A path relative to which Markdown files will be [imported](#importing-files).
+
+### `encoding`
+
+Type: `string`\
+Default: `utf8`
+
+Encoding for imported Markdown files.
+
+### `markdownit`
+
+Type: `object`\
+Default: `{}`
+
+Options passed to the `markdown-it` library. See the [available options](https://github.com/markdown-it/markdown-it#init-with-presets-and-options).
+
+### `plugins`
+
+Type: `array`\
+Default: `[]`
+
+Plugins for `markdown-it`.
+
+Example:
+
+```js
+import {light as emoji} from 'markdown-it-emoji'
+
+markdown({
+  plugins: [{
+    plugin: emoji,
+    options: {} // Options for markdown-it-emoji
+  }]
+})
+```
+
+[npm]: https://www.npmjs.com/package/posthtml-markdownit
+[npm-version-shield]: https://img.shields.io/npm/v/posthtml-markdownit.svg
+[npm-stats]: http://npm-stat.com/charts.html?package=posthtml-markdownit
+[npm-stats-shield]: https://img.shields.io/npm/dt/posthtml-markdownit.svg
+[github-ci]: https://github.com/posthtml/posthtml-markdownit/actions/workflows/nodejs.yml
+[github-ci-shield]: https://github.com/posthtml/posthtml-markdownit/actions/workflows/nodejs.yml/badge.svg
+[license]: ./LICENSE
+[license-shield]: https://img.shields.io/npm/l/posthtml-markdownit.svg