Leo

Leo is a Markdown, Middleman-powered writing environment. It allows you to quickly create Markdown files, and it automatically generates the sidebar sections for you. For example, just create source/index.md, and then add the following Frontmatter at the top of the document.

Note: Middleman will use the source/index.md file as the root file, so make sure that's what you first page is named. You can change the title to be whatever you'd like, though.

---
title: Introduction # The page title
type: page # Classify this document as a page
---

Priority

In data/priority.yml, add the order of all of your pages (including nested pages), so that the sidebar is ordered correctly and the pager navigation works.

For example:

- Welcome
- Example
- Parent
- Parent - Child
- Parent - Another Child

Note Nested pages must have the Parent - title with its parent prefixed in the YAML file to avoid identically named file clashes.

Nested Pages

If you want nested pages:

• Add a new subdirectory
• Name the root page subdirectory/index.md

In that root page, add some more Frontmatter to the top of the page:

---
title: Parent Page # The page title
type: page # Classify this document as a page
children: true # Tells Leo that this page has nested child pages
---

Next, add your nested pages in that sub-directory, and add the following Frontmatter to those nested pages:

---
title: Child Page # The page title
type: page # Classify this document as a page
nested: true # Tells Leo this is a nested page
parent: Parent Page # The parent page title that this is nested under
---

That's it! Now you'll have a nicely formatted book, with sections, that you can use to write your content.

Leo uses GitHub's Markdown parser, so you can follow the Mastering Markdown document on the GitHub guides.

Standard Sidebar

If you don't want a collapsed sidebar with a hamburger menu, then add the following to source/assets/stylesheets/_config.sass:

$sidebar-collapsible: false

Overriding Styles

If you need to override any of the styling, open up source/assets/stylesheets/foundation/_config.sass, and then duplicated any variable you want to override into the source/assets/stylesheets/_config.sass file.

Note: Be sure to remove the !default flag!

Subdirectories

If you put your application within a subdirectory and not the root, in order for the keyboard shortcuts to work properly, you'll need to specify the subdirectory name in data/leo.yml. There is an example in there already.

Setup

Now that you know the basics, you need to get everything set up to start writing.

gem install bundler

Then run:

bundle install

Running the Application

You run the application by starting the Middleman server:

middleman s

If you're using Rbenv with binstubs:

./bin/middleman s

Building the Static Files

To build the static files:

middleman build

Or, if you're using Rbenv:

./bin/middleman build

Deploying

If you'd like to deploy the site, add a Rakefile and take a look at the Baseman deploy documentation.

Note: Be sure to remove the Rakefile from the .gitignore!