zero config <zero-md>

Share rendered markdown files without upkeep. Fully-encapsulated fork of <zero-md>.

Demo this file at https://knksmith57.github.io/zero-config-zero-md.

Install

$ curl -O https://raw.githubusercontent.com/knksmith57/zero-config-zero-md/master/index.html

Usage

./README.md is loaded by default; use ?file=<path> to specify a different markdown file:

## zeit/serve
$ npx serve -p 8080

## ./README.md (default)
$ open http://localhost:8080

## explicitly load ./README.md
$ open http://localhost:8080?file=README.md

## ./CONTRIBUTING.md
$ open http://localhost:8080?file=CONTRIBUTING.md

## _this_ README.md
$ open http://localhost:8080?file=https://raw.githubusercontent.com/knksmith57/zero-config-zero-md/master/README.md

Why?

I needed a cheap way to share rendered markdown files without upkeep. zero-md almost did it.

@zerodevx glued a bunch of really great tools and ideas together into a clean, composable webcomponent with really good documentation!

Unfortunately, the user is required to:

• host a handful of static assets or rely on third-party CDNs
• modify index.html to render a new / different markdown file

This is really not a big deal. I'm just super lazy, so here's a single index.html file that uses a ?file= query param to do all that ^^ instead.

License

Powered by cool stuff from cool people:

• zero-md by @zerodevx
• marked by @chjj
• GFM theme by @sindresorhus
• GHColors theme by @aviaryan
• h5bp
• Polymer
• PrismJS

Anything that's left is yours under MIT.

♥︎

Assembled with <3 by @knksmith57