aras-p / markdeep-docs-style

Documentation CSS style for Markdeep
BSD 2-Clause "Simplified" License
25 stars 2 forks source link
markdeep

Documentation CSS style for Markdeep

Note: this repository is obsolete, since Markdeep 0.22 rolled in this style into official release (as apidoc.css). And also added note/warning/error "admonitions" syntax support. Now that's some impressive turnaround time! \o/

Markdeep is a sweet Markdown processor script that allows you writing extended Markdown files, and have them vieweble formatted directly in the browser. No Markdown processors to run or any of that stuff!

The default Markdeep styling makes the result look more like a book than a "documentation page", so I cooked up an alternative CSS stylesheet to make it look different.

Here's a little example page: formatted and raw source.

Comparison

To use it in your Markdeep document, just put a <link rel="stylesheet" href="https://github.com/aras-p/markdeep-docs-style/blob/master/markdeep-docs.css"> somewhere on the page, and have markdeep-docs.css in the same folder.

License is either public domain or BSD 2-clause, whichever is more convenient for you.