Strapdown.js makes it embarrassingly simple to create elegant Markdown documents. No server-side compilation required. Use it to quickly document your projects, create tutorials, home pages, etc. (For example, the page you are reading was generated by Strapdown).
Simply copy the HTML template below and drop it on any static file server:
<!DOCTYPE html>
<html>
<title>Hello Strapdown</title>
<xmp theme="united" style="display:none;">
# Markdown text goes in here
## Chapter 1
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua.
## Chapter 2
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
</xmp>
<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
</html>- Search-engine friendly
- Cross-browser compatible (tested with mobile Safari, IE 8/9, Firefox, Chrome)
- Github-flavored Markdown (tables, syntax highlighting, etc)
- Themeable
Bootstrap themes from Bootswatch.com are included for your convenience. Simply include the attribute theme in your <xmp> tag with one of the following theme names (default is vanilla Bootstrap):
For convenience the library is hosted at strapdownjs.com (as in the source above), but if you prefer to host it yourself make sure to save all files contained in /v/<version_number>, as the library dynamically loads all necessary stylesheets, etc.
It's an unlikely scenario, but since Strapdown uses the <xmp> tag to wrap your Markdown (so that users don't have to escape special HTML characters), your text can't contain the string </xmp>.
All credit goes to the projects below that make up most of Strapdown.js:
- Marked - Fast Markdown parser in JavaScript
- Google Code Prettify - Syntax highlighting in JavaScript
- Twitter Bootstrap - Beautiful, responsive CSS framework
- Bootswatch - Additional Bootstrap themes
