title: How can I sync documentation with Github Pages?
body: <p>I have a project together with several people and we have a <code>README.md</code> file with a bunch of GitHub Flavored Markdown that is rendered on our GitHub page. We also set up a GitHub Pages branch which is hosted under our GitHub Organization's subdomain, and used the <a href="https://help.github.com/articles/creating-pages-with-the-automatic-generator"><strong>Automatic Page Generator</strong></a> simply loading in our <code>README.md</code> file when we created our page. However, I notice that when I update our <code>README.md</code> file, it does not update the project page. Instead, we must go to the GitHub settings tab and recreate the project page, reloading the <code>README.md</code> file when we do it. </p>
  
  <p>Also, after reading about <a href="https://github.com/blog/1395-relative-links-in-markup-files"><strong>relative linking</strong></a> working between documentation files on the GitHub project directory pages. I very much like the markdown as it saves tons of time from having to write all the HTML out by hand for our documentation. What I would like however is to be able to have one <code>README.md</code> file which is able to include relative links to other documentation files located at <code>docs/*.md</code>. I was hoping there was an easy solution so that my other documentation files might also be included in my gh-pages branch and be hosted under my GitHub Pages subdomain and be rendered and/or themed.</p>
  
  <p>In other words, my questions are:</p>
  
  <ul>
  <li>Is there a way to have my README.md file automatically update on my Github Page subdomain?
  
  <ul>
  <li><strong>[ EDIT ] :</strong> No appears to be the answer if using the Automatic Page Generator. You must go to the settings page for the repo and reload it every time there is a change in order to update it.<br>
  &nbsp;</li>
  </ul></li>
  <li>Is there a way I can have my relative links to my documentation on my README.md file work on my Github Pages, perhaps my somehow syncing my <code>/docs/*.md</code> to my Github Pages and somehow rendering and/or theming them?
  
  <ul>
  <li><strong>[ EDIT ] :</strong> From what I've learned since writing this question it appears that this is only possible on GitHub pages through the use of a <a href="http://www.mzlinux.org/?q=node/415"><strong>static site generator</strong></a> like the ruby gem <a href="https://github.com/mojombo/jekyll"><strong>Jekyll</strong></a> and probably some uses of the <a href="https://help.github.com/articles/post-receive-hooks"><strong>webhooks supported by GitHub</strong></a> that are mentioned in the comments below. I am trying currently trying to find an optimal solution.<br>
  &nbsp;</li>
  </ul></li>
  <li>Better yet, is there an even easier way I can do this and perhaps have just one copy of my README.md and documentation that is used on both gh-pages and my main branch and makes everything easiest?
  
  <ul>
  <li><strong>[ EDIT ] :</strong> It seems this one is almost definitely a no. I was thinking about the possibility of something built into GitHub to allow this. It seems that better support for this kind of thing may could be built into GitHub Pages in the future, or at least I definitely hope it will be.<br>
  &nbsp;</li>
  </ul></li>
  </ul>