Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
92 lines (65 sloc) 2.89 KB

Welcome to gh-talks's documentation!

The idea behind this python package is that it allows you to quickly index all your slides.

Installation

To install simply:

pip install ghtalks

Basic usage

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

Where 2015-04-05-using-gh-talks and 2012-12-15-my-christmas-day-talk are directories that contain talks. The head.html, header.html and 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:

gh-talks -s

Take a look at the github repository where there is an examples directory that was used to create this site

You do not need to keep the head.html, header.html and footer.html files in the same directory as you want the index.html file. 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.

Contributing

Any contributions are more than welcome.

A test suite is in place, here is the status on travis:

https://travis-ci.org/drvinceknight/ghtalks.svg?branch=master

There is also a waffle board for issues here:

'Stories in Ready'

Please get in touch!

Indices and tables