Sign inSign up

tantalic/servemd

By tantalic

•Updated over 8 years ago

A simple web server for serving markdown files

Image
0

869

tantalic/servemd repository overview

⁠servemd

Servemd makes it simple and fast to serve one or more markdown⁠ files without the build process required by static site generators. Servemd can be used for quick local viewing or to serve content to thousands of visitors.

⁠Configuration

Environment VariableDescriptionDefault Value
BASIC_AUTHUsername and password for HTTP basic authentication. In the form of user1:pass1,user2:pass2None
X_ROBOTS_TAGSets a X-Robots-Tag header. Example: "noindex, nofollow"None
DOCUMENT_EXTENSIONExtension used for markdown files.md
DIRECTORY_INDEXFilename (without extension) to use for directory indexesindex
MARKDOWN_THEMETheme to use for styling markdown. Can be one of the following built-in themes: clean, github, developer or the path to a custom CSS file to include.clean
TYPEKIT_KIT_IDKit ID to include webfonts from the Typekit service. For use alongside a custom markdown theme.
CODE_THEMESyntax highlighting theme (powered by highlight.js⁠)None

⁠Using as a Base Image

The tantalic/servemd docker image can be used as a base for deployment. To create an image simply add your content to /content and configure via environment variables in your Dockerfile:

FROM tantalic/servemd:v0.6.0
MAINTAINER Your Name <[email protected]>

ENV MARKDOWN_THEME developer
ENV CODE_THEME solarized-dark

ADD content /content

Tag summary

Content type

Image

Digest

Size

8.3 MB

Last updated

over 9 years ago

docker pull tantalic/servemd