@tinyhttp/markdown

npm (scoped) npm

tinyhttp static markdown middleware based on marked (markdown library). Useful for creating simple static Markdown sites with basic routing. Used by tinyhttp website.

Install

pnpm i @tinyhttp/static

API

markdownStaticHandler(dir, options)

Handles static files and transforms markdown in HTML in a specified directory. It tries to assign root to README.md or index.md (and with .markdown extension too) in case any of them exists.

Options

Example

import { App } from '@tinyhttp/app'
import { markdownStaticHandler as md } from '@tinyhttp/markdown'

new App()
  .use(
    md('docs', {
      prefix: '/docs',
      stripExtension: true,
      markedExtensions: [
        {
          headerIds: true
        }
      ]
    })
  )
  .listen(3000)

Install

pnpm i @tinyhttp/markdown

Version

1.0.20

Source

packages/static