remark-redirect

Remark plugin for changing links to markdown files to HTML files.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-redirect
1.0.03 years ago5 years agoMinified + gzip package size for remark-redirect in KB

Readme

remark-redirect
CI/CD Status MIT License stars
Remark plugin for redirecting links to markdown files into the equivalent HTML files (e.g. [Link](link.md) into [Link](link.html)). Also changes to README.md into index.html.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.
npm:
npm install remark-redirect

Usage

import { unified } from 'unified'
import markdown from 'remark-parse'
import html from 'rehype-stringify'
import remark2rehype from 'remark-rehype'
import redirect from 'remark-redirect'

unified()
  .use(markdown)
  .use(redirect)
  .use(remark2rehype)
  .use(html)

License

MIT © Alex Shaw