skunkwerks / swirl

[alpha] IETF PPSP RFC7574 in Erlang/OTP -- an incomplete non-functional partial implementation
http://www.swirl-project.org/
Apache License 2.0
175 stars 13 forks source link

implement hugo for documentation #8

Closed dch closed 10 years ago

dch commented 10 years ago

hugo is a fast static site generator that doesn't require installing a continent of tools.

./doc/config.yaml


---
contentdir: "content"
layoutdir: "layouts"
publishdir: "public"
builddrafts: false
indexes:
    category: "categories"
baseurl: "http://swirl-project.org/doc"
title: "Bringing Live Streaming to the World"
permalinks:
    post: /:title/
andywenk commented 10 years ago

I will take this bit

PR from @dch how to add syntax highlighting in Hugo: https://github.com/spf13/hugo/pull/267

andywenk commented 10 years ago

started to integrate hugo https://github.com/skunkwerks/swirl/commit/c2be9eb0bcffe434743513e12ad03ce7486e359c

andywenk commented 10 years ago

I have finished the work on the topics checked in the list above. I am wondering, where we host the docs and how we transfer them to the location. If you give me some credentials, I could work on that or simply push it via rsync. We could also checkout the repo on that server and create the docs locally. I am not sure if we could even send a git hook from this repo to create the docs on the server, when they have been updated.

dch commented 10 years ago

@andywenk fantastic!

My clone of your commit doesn't build correctly:

ERROR: 2014/05/06 Rendering error: template: chrome/header.html:52:44: executing "chrome/header.html" at <.Site.Indexes>: range can't iterate over <*hugolib.TaxonomyList Value>
ERROR: 2014/05/06 Rendering error: template: chrome/header.html:52:44: executing "chrome/header.html" at <.Site.Indexes>: range can't iterate over <*hugolib.TaxonomyList Value>

atm we seem to have a mix of source (.md) and resulting html files, which is a bit unclean, so I tried to tidy it up a bit here https://github.com/skunkwerks/swirl/tree/feature/8-add-docs-squashed but my branch doesn't compile without "fixing" the above error by simply removing the sidebar section (see https://github.com/skunkwerks/swirl/commit/0fe2a20219ac04074a75f0ce33065aefa6a63161#diff-a07190179d3753b5f15127a94faea0bcL52 for the hack). Do you know what's missing there to have the sidebar work?

I also removed a bunch of AFAICT unnecessary files in the themes and other content.

atm results are stored in the gh-pages branch, eventually I'll move it to a google storage site (like AWS S3) when I have a free moment.

I tried moving the gh-pages branch content directly into ./doc/static/ which works, except hugo then over-writes index.html. So maybe the hugo-generated content should go into /docs/static/ or similar, but then the blog URLs might have to shift too. I'm happy to have a crack at that next week unless you get to it beforehand.

dch commented 10 years ago

this is now in `feature/site'. I'll merge that & then pull in the latest source docs to master. This is looking pretty good now! Thanks for your help @andywenk!