Introduction

Flatdoc is a small JavaScript file that fetches Markdown files and renders them as beautiful, navigable web pages. We've adapted it and built it into a restdb.io database template.

• Save time creating docs for your projects
• Host multiple projects for your organisation in a sentral database
• Create drafts and publish docs when they're ready
• restdb.io serves the content
• SEO friendly server rendering and automatic sitemap.xml generation

Getting started

1. Install the database template in your account
2. Create a project record
3. Add docs as child-records to the project (Markdown)
4. Docs are ready! - view them from the database URL

You can change the theme and modify this template using "Developer Mode" in the database (edit Page). Read more in the restdb.io Docs.

Writing docs

Docs are added as records in restdb.io. The screenshot below shows the list of docs. The first doc is the one you're reading right now.

restdb.io has a built-in SimpleMDE editor which lets you write and preview Markdown. You can also use restdb.io's Draft mode to save documents as drafts.

Markdown extras

Flatdoc offers a few harmless, unobtrusive extras that come in handy in building documentation sites.

Code highlighting

You can use Markdown code fences to make syntax-highlighted text. Simply surround your text with three backticks. This works in GitHub as well. See [GitHub Syntax Highlighting][fences] for more info.

``` html
<strong>Hola, mundo</strong>
```

Blockquotes

Blockquotes show up as side figures. This is useful for providing side information or non-code examples.

Blockquotes are blocks that begin with >.

Smart quotes

Single quotes, double quotes, and double-hyphens are automatically replaced to their typographically-accurate equivalent. This, of course, does not apply to <code> and <pre> blocks to leave code alone.

"From a certain point onward there is no longer any turning back. That is the point that must be reached."
--Franz Kafka

Buttons

If your link text has a > at the end (for instance: Continue >), they show up as buttons.

More restdb .io templates >

Acknowledgements

Adapted to restdb.io by Knut Martin Tornes @knutmt

© 2013, 2014, Rico Sta. Cruz. Released under the MIT License.

Flatdoc is authored and maintained by Rico Sta. Cruz