return to pancake.io
pancake.io :: documents
Basic Usage

Pancake reads files from your Dropbox folder, and makes them available from the web. Here you'll find examples of where you might find your files; expected behavior for different types of files, e.g. text files vs images; and how you can take advantage of Pancake's Markdown page conversion.

Where to Save Files

Files in your Dropbox/Apps/Pancake.io folder are accessible from your pancakeapps.com subdomain. For example, if your site's subdomain is mysite:

In your Dropbox... On the Web
Apps/Pancake.io/mypage mysite.pancakeapps.com/mypage
Apps/Pancake.io/abcd/mypage mysite.pancakeapps.com/abcd/mypage
Apps/Pancake.io/abcd/mypage.txt mysite.pancakeapps.com/abcd/mypage.txt

pancakeapps.com

Your files are accessible from your pancakeapps.com subdomain, which you can customize. The root url without any path will resolve to one of the following files in the top-level folder (in order of precedence):

Only index.html is served as is; the rest will be rendered as Markdown.

Supported Files

File types Processing
.txt, .md, .markdown Markdown processor. Accepts config blocks.
.html, .css, .js No processing; file served as is.
.jpg, .jpeg, .png, .gif, .ico No processing; served as is from Dropbox.
.pdf, .doc, .docx .xls, .xlsx, .ppt, .pptx, .psd, .ai, .ps Google previewer, uses default template.

Files that do not have an extension will be passed through the Markdown processor as well, although this is not officially supported and may be deprecated in the future.

Markdown

This is one of Pancake's most useful features: the ability to convert text files into full-fledged web pages. Without a single line of code.

Text files with the .txt, .md, or .markdown extension will be automatically processed by Pancake as Markdown files.

Markdown is a set of simple rules that indicates how the text should converted, and it is designed to be human readable. It's just as comfortable to view your file on Pancake as it is in your text editor.

Markdown Primer

Text Result
# Header 1

Header 1

## Header 2

Header 2

### Header 3

Header 3

this is __emphasized__ this is emphasized
this is **bold** this is bold
this is a [link](http://pancake.io) this is a link

Extensions

Pancake supports the following extensions to Markdown:

You can selectively enable or disable Markdown extensions in the page config block.