Welcome to gh-talks’s documentation!¶
The idea behind this python package is that it allows you to quickly index all your slides.
To install simply:
pip install ghtalks
After installing, assume you have a directory that looks something like this:
Talks ├── talks │ └── 2015-04-05-using-gh-talks │ └── index.html │ └── Archive │ └── 2000-01-01-y2k-is-here │ └── index.html │ └── .html │ └── 2012-12-15-my-christmas-day-talk │ └── index.tex │ └── index.pdf │ └── images │ └── 2013-12-15-my-other-christmas-day-talk │ └── index.link │ └── images └── README.md └── header.html └── head.html └── footer.html └── main.css
2012-12-15-my-christmas-day-talk are directories that contain talks.
footer.html files can be
considered to be template files.
To generate an index.html file that will find the directories formatted as above (with an ISO formatted date at the top of the name) you can simply run:
You do not need to keep the
footer.html files in the same directory as you want the
There are command line arguments that you can fun to point at particular files:
gh-talks -s -hd path-to-head.html -hr path-to-header.html -fr path-to-footer.html
Note that an
index.link file can be used, in which case the link on the
generated page will link to the url given in the first line of that file.
Any contributions are more than welcome.
A test suite is in place, here is the status on travis:
There is also a waffle board for issues here:
Please get in touch!