@hackclub/markdown
Render Markdown to HTML, Hack Club-style
Last updated 6 months ago by lachlanjc .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @hackclub/markdown 
SYNC missed versions from official npm registry.

@hackclub/markdown

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

Based on the Next.js documentation site.

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

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. 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')
)
Param Default Description
input Req’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.
removeTitle false Bool. Remove starting h1 (if titles are rendered separately).

We recommend using gray-matter alongside @hackclub/markdown for parsing frontmatter, but it’s not included in this package.

MIT License

Current Tags

  • 0.0.1-alpha.0                                ...           latest (6 months ago)

1 Versions

  • 0.0.1-alpha.0                                ...           6 months ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |