Content Organisation

Content in an Aoife site comprises Markdown text files with the extension .md. These files can have optional information at the very beginning called the frontmatter. Aoife respects the hierarchical file/folder organisation you provide for your content to simplify things.

Aoife expects your content to be arranged on disk in the same way you want it to appear in the final rendered website. Without any additional configuration on your part, the following source organisation will just work and provide a functioning website:

content
  - about
  --- index.md            // http://aoife.io/about
  - post
  --- First Post.md       // http://aoife.io/post/first-post.html
  --- Second Post.md      // http://aoife.io/post/second-post.html
  --- sub-section
  ------ Third Post.md    // http://aoife.io/post/sub-section/third-post.html
  - review
  --- Die Hard.md         // http://aoife.io/review/die-hard.html

You can nest content at any level but the top level folders within the /content folder are special and are either sections or pages.

Structure

It makes sense that the way you store your files on disk is the way you want them displayed to the user in the final rendered website. As displayed above, the organisation of your source content will be mirrored in the URL of your site. Notice that the top level /about page URL was created using a directory named about with a single index.md file inside. This is the organisation format you should use to create a single page. Creating a top-level folder containing Markdown files without an index.md file creates a section rather than a page. The index.html for that section will be automatically created by Aoife.

Sometimes, you need more granular control over your content. In these cases, you can use the frontmatter at the beginning of each Markdown file to do just that.

Modified: Dec 6, 2016 at 21:25:52

Aoife v0.9.0 documentation