# Strapdown.js 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**: ```html
Hello Strapdown
# 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.
``` ### Features + Search-engine friendly + Cross-browser compatible (tested with mobile Safari, IE 8/9, Firefox, Chrome) + Github-flavored Markdown (tables, syntax highlighting, etc) + Themeable ### Themes Bootstrap themes from [Bootswatch.com](https://bootswatch.com/) are included for your convenience. Simply include the attribute `theme` in your `
` tag with one of the following theme names (default is Default Base Bootstrap):
### Set navbar color The types of navbar color are `primary`, `dark` and `light`. Default is `primary`: ```
``` ### Self-hosting If you prefer to host it yourself make sure to save *all* files contained in `/v/
`, as the library dynamically loads all necessary stylesheets, etc. ### CDN We were looking for it. Currently it's jsDelivr is the best CDN. I have a separate project dedicated to:
### Limitations It's an unlikely scenario, but since Strapdown uses the `
` tag to wrap your Markdown (so that users don't have to escape special HTML characters), your text can't contain the string `
`. ### Credits All credit goes to the projects below that make up most of Strapdown.js: + [Strapdown.js](https://github.com/arturadib/strapdown) - Original project. This project forked + [Marked](https://github.com/markedjs/marked) - Fast Markdown parser in JavaScript + [Google Code Prettify](https://github.com/googlearchive/code-prettify) - Syntax highlighting in JavaScript + [Bootstrap](https://getbootstrap.com/2.3.2/) - Beautiful, responsive CSS framework + [Bootswatch](https://bootswatch.com/) - Additional Bootstrap themes