a dead-simple way to publish your markdown files as webpages
JavaScript CSS

README.md

Baseplate

Beautiful documents, no pain

Baseplate is a dead-simple way to turn markdown files into beautifully-styled webpages without any external programs. Just drop files in a web-accessible directory and go. It uses showdown.js to render markdown on the fly in the browser.

Features:

  • Updating the output is simple: just edit the markdown source files. Whenever you reload the Baseplate index page, AJAX fetches the markdown file and re-renders the output using showdown.js.
  • No special server is required. Publish documents on any website.
  • Last-Modified headers are parsed and included in the page footer to indicate when the content was last changed.
  • Page titles are automatically updated with the content of the first H1 header.

Non-features:

  • Baseplate is not as flexible as alternatives like jekyll; it cannot run other programs like Sass to post-process or minimize CSS or JavaScript files.
  • All markdown source files must be web-accessible. Otherwise, Baseplate would not be able to read them.

Demo

See this document rendered by Baseplate.
http://dev.quadpoint.org/baseplate/#!/README

Baseplate uses README.md as the source.
http://dev.quadpoint.org/baseplate/README.md

Installation and usage

Three simple commands get you a full Baseplate installation.

% git clone git://github.com/msparks/baseplate.git
% cd baseplate
% python -m SimpleHTTPServer 8001

The last command starts a Python webserver that serves files from the baseplate directory at http://localhost:8001. If everything worked, you should see this document at that URL.

Adding new documents is easy. Just create new markdown files (with the extension .md) in the baseplate directory (the same one that contains index.html). To see these documents using Baseplate, add #!/pagename to the URL, where pagename is the name of the corresponding file without the .md extension. For example, the content for this page is in README.md, so the rendered page can be accessed at http://localhost:8001/#!/README.

If no page is specified in the URL, Baseplate will attempt to load index.md first. If that fails, it will try to load README.md (this file).

Hosting Baseplate elsewhere

The quick-start example above shows how to host Baseplate-rendered documents on your own computer, but you can easily use Baseplate anywhere you have public webspace. Just copy the files created by the git clone command to a web-accessible directory on your webhost of choice. After that, you need only add and update your markdown files.

Using Baseplate on Dropbox

Dropbox is a free service for putting your files in the cloud. All Dropbox accounts include a Public directory that you can drop files in to instantly publish on the web. This feature works great with Baseplate; just install Baseplate in your Public directory and copy the public link to the index.html file in your Baseplate installation.

FAQ

Can I organize my files into subdirectories?

Yes. In fact, this is an excellent way to organize many collections of documents. For example, you may have a directory for notes and a directory for projects containing many subdirectories for all of your projects. Your file tree might look something like this:

.
|-- notes
|   |-- index.md
|   +-- programming.md
+-- projects
    |-- foobarbazzle
    |   |-- index.md
    |   +-- bazzle.png
    +-- quuxinator
        |-- index.md
        +-- settings.md

If a directory is specified in the URL hash, the index.md file within that directory is loaded. To access to quuxinator project in the example above, you would use the URL hash #!/projects/quuxinator/. Note that the last forward slash is required to indicate that it is a directory. To access the settings document in the quuxinator project, you would just add settings to the URL hash: #!/projects/quuxinator/settings.

How do I use images with Baseplate?

Image files are referenced relative to where the Baseplate index.html file is installed. To include an image in a document, copy the image file to the directory within your Baseplate installation, such as into the directory containing the document that references the image, and reference it using regular markdown syntax. For example, to include the bazzle.png image in the subdirectories FAQ example above, you would use:

![Alt text](projects/foobarbazzle/bazzle.png)

Note that there is no forward slash before projects; this would create an absolute path that would be invalid if your Baseplate installation is within a subdirectory of the document root on the webserver. Also, the full relative path to images (and other files) must be specified, even within documents in projects/foobarbazzle/, because web browsers construct their URLs relative to the Baseplate root directory.