A Middleman site that pulls in its own readme as the index

WHMII · January 7, 2015, 4:59pm

I am working on a Middleman app that builds out to it’s own gh-pages branch.

Rather that copying over and maintaining the Readme in two places, I would like to configure middleman to grab the repo’s root level (outside of source) README.md file and use that to build the index page.

Is this possible? How would it be done?

tommysundstrom · January 7, 2015, 5:13pm

Simple solution: Use ln to make a copy of the README-file.

WHMII · January 7, 2015, 5:55pm

Definitely, We have a few collaborators so an automated solution would be better.

I was actually surprised that there was no config for an output XXX.file as YYY.file

tommysundstrom · January 9, 2015, 10:18am

I should have been clearer.

ln (in the terminal) is not making a copy. It makes the same file appear in several places. So if you change it in one place these changes will appear in all other places simultaneously.

rriemann · January 13, 2015, 9:04am

Maybe you want to do something like this:

github.com

rriemann/middleman-blog-template-duocolor/blob/master/source/index.html.md.erb

---
title:
layout: page
---
<%
  content_for(:sidebar) do
    [
      # partial("aside/recent-posts"), 
      partial("aside/recent-tweets"),
      partial("aside/blog-roll"), 
      partial("aside/affiliated-with"), 
    ].join
  end
%>

* list element with functor item
{:toc}

<%= File.read('README.md') %>

For the demo page of my Middleman template, I included the readme.md via a ruby command.