MMoTH: Multiscale model of The Heart

This is the documentation hub for MMoTH, a collaborative project led by:

Repositories

Documentation guidelines

MMoTH documentation:
- is hosted on GitHub Pages using (in nearly all cases) markdown formatting
- is published from the docs folder of the master branch
- the home-page for the repo documentation is published from my_repo/docs/index.md
- sub-pages are published from my_repo/docs/pages/sub_area_1/sub_area_1.md
  - include images in folders like my_repo/docs/pages/sub_area_1/images
- on your home page, include a table of contents with links to sub-pages using markdown similar to

[This page](index.html)
+ Topic 1
  + [Topic 1, page a](topic_1/page_a.html)
  + [Topic 1, page b](topic_1/page_b.html)
+ Topic 2
  + [Topic 2, page c](topic_2/page_c.html)

To add documentation to a project
- Open the repository in GitHub
- Settings tab -> GitHub Pages, change source to master branch/docs (the pages option is near the bottom of the screen, and may not be visible without scrolling)
- Change theme to minimal (this creates a side-bar)
- Add a link to the home-page on the side-bar (which provides a simple link back to your table of contents) as follows
  - Create a new docs/_layouts folder
  - Copy REDCap_data/docs/_layouts/default.html to docs/_layouts/default.html for your new repo
  - Update your new default.html file to include a link to your index.md home-page
- Commit your documentation
- Push to GitHub
- Wait a few minutes (30 s to ~5 minutes?) and your site should be visible at http://mmoth.github.io/my_repo
If the site doesn’t publish
- check the Settings tab -> GitHub Pages for potential error messages warning about failed site builds
- check your email for similar build warnings
- if all fails, strip your site back to basics and rebuild, one page at a time