Skip to content

johnellmore/markdownhorse

Repository files navigation

🐴 markdown.horse 🐴

Write markdown files, serve them as HTML.

CI status badge

Add this line to the beginning of any Markdown document:

<script src="https://markdown.horse/v3.js" crossorigin integrity="sha256-WxElWxelir8xqqX9NHALSFgrj2FuMOdnmMK2wQ7xqFM="></script>

and change the extension to .html or .md.html. When you open the file in a browser, you'll see nicely-rendered Markdown--no extra work required.

Features

  • CommonMark spec
  • Inline HTML
  • Emoji. For example, :horse: shows 🐴.
  • Code syntax highlighting via highlight.js
  • Heading anchors. For example: markdown.horse/#features
  • Single external JS file. Only requires one additional network resource.
  • Works locally. No HTTP server needed; local .md/.html files work great without being uploaded anywhere.
  • Version-pinned. The integrity attribute guarantees that the JS won't change later and inject ads or something. Old versions will remain perpetually available (barring security issues).

Known issues

  • There's a FOUC before markdown.horse loads. The JS asset has a cache-control: immutable header, so the FOUC doesn't normally appear on subsequent page loads.
  • If you use <script> tags in your Markdown doc, they'll run twice: on initial document load, and again after markdown.horse formats everything.
  • No automatic dark mode (yet) for those with browser/OS preferences set to dark mode.
  • The styles are opinionated and simple. They probably needs tweaking, and to have a demo page showing off the styles of all supported content.

MIT Licensed. Inspired by MarkDeep. Contribute on Github.

About

Write markdown files, serve them as HTML

Resources

License

Stars

Watchers

Forks

Languages