Integration with GitHub

GitHub allows for documentation loaded from docs in your repo root. Here's a strategy for using loft_docs with a github repository.

File Structure

    .
    ├── docs
    │   ├── how-to.html
    │   └── index.html
    └── documentation
        ├── core
        ├── core-config.sh
        └── source
            └── how-to.md

1. Install Loft Docs in your repo in documentation/core.

2. Setup core-config.sh to compile website to docs.

   website_dir = '../docs'
   

3. Ensure that docs/index.html is created on compile.

Setup on github.com

1. Load your repository page in the browser.
2. Click the Settings link.
3. Scroll down to GitHub Pages.
4. Set source to master branch /docs folder and click Save.
5. Copy the publish url, e.g. https://aklump.github.io/visual_sitemap/
6. Return to the repo page.
7. Click the edit button.
8. Paste the copied URL into Website and click Save.
9. Visit the link and ensure the docs appear as expected.

10. Add something like the following to your README.md file, near the top.

    **Visit <https://aklump.github.io/visual_sitemap> for full documentation.**