/chameleon

Turn repo with markdown files into a nice looking blog

Primary LanguageGo

Chameleon

Chameleon is web application (blog engine) that reflects content from markdown files from a git repository. Powers articles.orsinium.dev.

Features:

  • Markdown (full support for CommonMark and GitHub Flavored Markdown)
  • Jupyter notebooks
  • Minimalistic UI
  • Easy to use, no CI or a special repo structure required
  • Zero configuration
  • Single binary
  • Automatically pull the repo by schedule
  • Built-in prose linter (Vale)
  • Syntax highlighting (Prism)
  • Formulas (MathJax)
  • Emoji (enescakir/emoji)
  • Views count
  • Great performance and server-side caching
  • Optional password protection
  • Search
  • Minification (minify)

Usage

Build:

git clone https://github.com/life4/chameleon.git
cd chameleon
go build -o chameleon.bin .

Run:

./chameleon.bin --path ./path/to/repo/