gmdd

README

Go markdown daemon (gmdd)

Gmdd is a daemon for serving and highlighting markdown files with an opinionated set of features. It compiles into a single executable that encompasses all assets and configuration.

Features

Math expressions

Math expressions are supported in TeX format and are processed with the KaTeX library. (See the KaTeX wiki for the list of supported functions.)

Math expressions must be in fenced or inline code blocks. Fenced code blocks must use the math language identifier. Inline code blocks must start and end in $ delimiters.

Diagrams

Diagrams are supported in the mermaid format and are processed with the mermaid library. (See the mermaid documentation for the list of supported diagram types and syntax.)

Diagrams must be in fenced code blocks and use the mermaid language identifier.

Code snippets

Codes snippets are highlighted with the highlight.js library.

Code snippers must be in fenced code blocks and use their respective language identifier.

Usage

Build

make

Run

./gmdd [${ROOT_DIR}]