@hackclub/markdown
npm i @hackclub/markdown

@hackclub/markdown

Render Markdown to HTML, Hack Club-style

by hackclub

0.0.43 (see all)License:MITTypeScript:Not Found
npm i @hackclub/markdown
Readme

@hackclub/markdown

Render Markdown to HTML, Hack Club-style. Used primarily on the Hack Club Workshops site.

yarn add @hackclub/markdown
# npm i @hackclub/markdown

Try the demo

Usage

This package does not include any frontend code, such as React or CSS.

This package is designed for rendering at build or otherwise on a server, not client-side— the bundle size is significant & it’s not been optimized for performance.

Always use with await.

import fs from 'fs'
import md from '@hackclub/markdown'

const getReadme = async () => (
  const text = fs.readFileSync('./README.md', 'utf8')
  return await md(text, '/README.md', '/static')
)
ParamDefaultDescription
inputReq’d!String. The Markdown text to transform.
filePath'/README.md'String. The Markdown’s path (for fixing relative image links).
imagePrefix'/'String. A prefix for the path to relative images.
removeTitlefalseBool. Remove starting h1 (if titles are rendered separately).

If you need to parse frontmatter, we recommend using gray-matter alongside @hackclub/markdown, but it’s not included in this package.


Partially based on the Next.js documentation site.

MIT License

Downloads/wk

21

GitHub Stars

15

LAST COMMIT

6mos ago

MAINTAINERS

5

CONTRIBUTORS

6

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
0.0.43
latest
6mos ago
No alternatives found
No tutorials found
Add a tutorial