Renderer

A lightweight service for rendering Markdown and plain text to HTML.

Overview

This service supports two rendering modes:

• Route-based rendering (/docs/page -> /docs/page.md or /docs/page/README.md)
• Remote-source rendering (/api/markdown/render?src=https://...)

Endpoints

• GET /healthz Health check.

• GET /api/markdown/render?src=https://... Fetches Markdown from a remote HTTP/HTTPS URL and returns rendered HTML.

• POST /api/markdown/render Reads Markdown directly from request body and returns rendered HTML.

• GET /api/text/render?src=https://...&title=... Fetches plain text from a remote HTTP/HTTPS URL and returns rendered HTML (title is optional, defaults to Text Viewer).

• GET /<route-without-extension> Resolves Markdown in order:

  • <route>.md
  • <route>/README.md Returns rendered HTML if found, otherwise a rendered 404 error page.

Rendering Features

• Markdown rendering powered by marked
• Server-side code highlighting via highlight.js
• Server-side math rendering via katex (SSR)
• TOC placeholders: [toc] and <!-- TOC -->
• GitHub-like Markdown style (github-markdown-css)
• HTML error pages for API and route rendering failures

Quick Start Examples