MarkdownRecord Docs

Version 0.1


Welcome to MarkdownRecord!

This document will walk you through the many powerful features of MarkdownRecord, and is created with MarkdownRecord itself. Hopefully, you are rendering this page locally from your own application, and will be able to get a peak under the hood to see how it all works by looking directly at the source markdown files.

If you haven't installed it locally yet, you can find instructions here.

After following the installation guide, you should see a markdown_record folder inside your application root. This folder contains three subdirectories: content, layouts and rendered.

Feel free to poke around and explore the files in the directories mentioned above as you go through this guide. They will serve as a great reference to help make sense of the features and concepts described here.


The general workflow while using MarkdownRecord, once installed in your application, is as follows:

  1. Write markdown content, using the Content DSL to define data within your markdown content.
  2. Run the provided Thor task to render your markdown content into HTML and JSON.
  3. Use the built in MarkdownRecord::ContentFragment model to directly reference your rendered content inside your application.
  4. Use the provided view helpers to link to the rendered content in your application's views, relying only on the controllers provided by the engine for serving the content if you wish.
  5. Use model classes inheriting from MarkdownRecord::Base to interact with your html and json rendered content, taking advantage of the associations you can define manually as well a the automatic associations they have based on content location.

The next step is to read through the Rendering Basics section to understand the basic rendering process of markdown source content into HTML and JSON.

The following links will take you to other sections of this guide. Each section builds upon the last, so it is recommended to read through them in order if you are new to MarkdownRecord.

0.1.4 Release Notes

Version 0.1.4 is the second beta version to be published and is packed with tons of big improvements. This is the first version that is really usable. Changes since 0.1.3 are as follows:

The above content was rendered from source files at: content/v_0_1/home