FAST simple markdown server (no indexing, no symlinks) report bugs: https://github.com/aerth/markdownd/issues (Heroku takes a couple seconds to load. Patience...)
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
docs switch link Jun 14, 2017
static add css Jun 14, 2017
theme add github link Jun 14, 2017
vendor syntax ? Jun 14, 2017
.travis.yml add linux, osx to travis May 15, 2017
CHANGELOG.md 0.0.10 May 15, 2017
Dockerfile Dockerfile May 9, 2017
LICENSE markdownd May 8, 2017
Makefile use build.sh May 12, 2017
Procfile -syntax flag Jun 14, 2017
README.md default to github_flavored_markdown Jun 9, 2017
build.sh less verbose Jun 9, 2017
css.go add css Jun 14, 2017
main.go print help to stdout for 'markdownd -h | more' Jun 14, 2017
main_test.go gofmt May 15, 2017

README.md

markdownd

./markdownd [flags] <directory>

./markdownd -toc -header theme/header.html -footer theme/footer.html .

Go Report Card Build Status

serves:

  • tries markdown file (.md) in .html request (/index.html tries /index.md first)
  • will serve .html if exists
  • serves static files and downloads if not .html or .md
  • no indexing
  • no symlinks
  • no ../ paths
  • raw markdown requests ( example: GET /index.md?raw )
  • custom index page (use flag: -index README.md)
  • generates table of contents with -toc flag
  • themed html with -header and -footer flag
  • now with syntax highlighting (use flag: -syntax)

installation

Compile using Go

go get -d -v github.com/aerth/markdownd
cd $(go env GOPATH)/src/github.com/aerth/markdownd
./build.sh

Download binary for your OS

Latest Release

docker

example launch code, modify $PWD/docs and 8888 to suit your needs

  • docker run -it -v $PWD/docs:/opt -p 8888:8080 aerth/markdownd

free:

The MIT License (MIT)

Copyright (c) 2017  aerth <aerth@riseup.net>

Permission is hereby granted, free of charge, to any person obtaining a 
copy of this software and associated documentation files (the 
"Software"), to deal in the Software without restriction, including 
without limitation the rights to use, copy, modify, merge, publish, 
distribute, sublicense, and/or sell copies of the Software, and to 
permit persons to whom the Software is furnished to do so, subject to 
the following conditions:

The above copyright notice and this permission notice shall be included 
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

contributing:

  • pull requests welcome
  • bugs/issues/features very welcome
  • please 'gofmt -w -l -s' before commits

logging:

2017/05/08 14:14:05 5577006791947779410 [::1]:58338 GET / -> docs/index.md
2017/05/08 14:14:05 5577006791947779410 serving markdown: /home/aerth/go/src/github.com/aerth/markdownd/docs/index.md
2017/05/08 14:14:05 5577006791947779410 closed
2017/05/08 14:14:05 8674665223082153551 [::1]:58338 GET /markdownd.png -> docs/markdownd.png
2017/05/08 14:14:05 8674665223082153551 serving image/png: /home/aerth/go/src/github.com/aerth/markdownd/docs/markdownd.png
2017/05/08 14:14:05 8674665223082153551 closed
2017/05/08 14:14:07 6129484611666145821 [::1]:58338 GET /index.html -> docs/index.html
2017/05/08 14:14:07 6129484611666145821 docs/index.html -> docs/index.md
2017/05/08 14:14:07 6129484611666145821 serving markdown: /home/aerth/go/src/github.com/aerth/markdownd/docs/index.md
2017/05/08 14:14:07 6129484611666145821 closed
2017/05/08 14:14:08 4037200794235010051 [::1]:58338 GET /test.html -> docs/test.html
2017/05/08 14:14:08 4037200794235010051 serving raw html: /home/aerth/go/src/github.com/aerth/markdownd/docs/test.html
2017/05/08 14:14:08 4037200794235010051 closed
2017/05/08 14:14:09 3916589616287113937 [::1]:58338 GET / -> docs/index.md
2017/05/08 14:14:09 3916589616287113937 serving markdown: /home/aerth/go/src/github.com/aerth/markdownd/docs/index.md
2017/05/08 14:14:09 3916589616287113937 closed