search

dmoles / adler

A minimalist Markdown wiki viewer
MIT License
0 stars 0 forks source link

readme

Adler

Build Status

Adler is a minimalist Markdown wiki viewer.

Building

Out of the box, Adler builds with go build / go install.

A magefile is provided to support compiling SCSS and embedding static assets; run mage -l for the list of tasks. Note that the first mage invocation may take some time as golibsass builds libsass from (C++) source.

With mage installed:

Without mage installed:

Usage

adler <root-dir> [-p <port>]

E.g., to serve from Markdown files in /Users/irene/suda.wiki on port 8282 (default is 8181):

adler /Users/irene/suda.wiki -p 8282

Name

Adler is named for Ada Adler (1878-1946), philologist, classical scholar, and translator of the Suda, arguably the greatest encyclopedia of the Early Middle Ages.