jekyll_site

This is a template for Jekyll static websites, which you can host for free as GitHub project Pages. This template is useful for simple documents: a set of pages and a table of contents. When used for a GitHub project page, the repository is completely forkable, i.e. someone can fork your document and host on their own copy right away without reconfiguring.

Simply copy this template into an orphan branch (called gh-pages) of a project repo on GitHub, and the site will get served at http://yourgithubusername.github.io/yourreponame. When you push to the branch, the site will be rebuilt. In the case of a standalone document with no code branches, the project is empty except for the Page (i.e. no master branch).

The markdown engine used is kramdown. Math notation via MathJax is supported.

Getting started

1. Create new repo on GitHub
2. Create corresponding local folder
3. git init
4. git checkout --orphan gh-pages
5. wget https://github.com/amacfie/jekyll_site/archive/master.zip
6. 7z x master.zip
7. cp -r jekyll_site-master/. ./
8. rm -rf jekyll_site-master master.zip
9. git remote add origin https://github.com/username/reponame.git
10. add and commit
11. git push -u origin gh-pages
12. edit name and baseurl in _config.yml
13. edit the content: the markdown files, including this README.md file
14. add, commit, and push, ...

To link to page.md, create a link to {{ site.baseurl }}/page.html. This practice is shown in the included markdown files.

Use ###, ####, etc. for headings within markdown files. (The document (site) title is h1, and the page title is h2.)

Consult the Jekyll documentation and GitHub Pages documentation for more information, e.g. how to locally build your site.