Skip to content
/ mds Public
forked from tlight/md

Minimal single page markdown server, with much more

License

Notifications You must be signed in to change notification settings

dienakakim/mds

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mds

A fork of tlight's md that uses the Goldmark renderer instead of Blackfriday. As is the original project:

Zero configuration minimal markdown server for local rendering.

Installation

go get github.com/dienakakim/mds

Usage

mds --file=README.md [--port=8080] [--dark]

License

Copyright © 2020 Dien Tran. See LICENSE file. Enough parts of the code have been rewritten that I can safely pronounce it "original".

P.S

md is a bad name for a project, as it clashes with the "make directory" command on Windows. This spurred me to initiate this fork, but along came various other features:

  • Tailwind CSS styling support
  • Dark theme (enabled with the flag --dark)
  • Syntax highlighting, for your favorite language

P.P.S: Cross-compilation build program

There is a build program at build/build.go that aids in producing binaries you see in the releases. It is intended to be run as

go run build/build.go mds v1.3.0

assuming you actually have Go installed, you are in the project folder and the version is currently v1.3.0.

About

Minimal single page markdown server, with much more

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 99.9%
  • Go 0.1%