search

NESCent / hip_hack_howto

Hackathon guidance from NESCent's Hackathons, Interoperability, Phylogenies working group.
1 stars 1 forks source link

make static website #56

Closed rvosa closed 7 years ago

rvosa commented 8 years ago

Continuing the discussion for #50 here because the thread is drifting from the topic of cleaning up the repo structure towards what our strategy should be for painlessly and quickly deploying a static website.

As I argued in the thread, a fairly painless approach might be to make our root-level README nice and readable (presumably striking a balance between what people want to read in a browser versus what they expect to find in a root-level README in a source tree) and give it a clear link to the wiki of this repo should we want to add more prose. Then, using the github pages wizard, we turn the repo into a github.io site, which will turn the README into pretty-ish HTML.

rvosa commented 7 years ago

I suspect we would also be better off NOT formatting the guidelines (which, presumably we would host on such a static website) as LaTeX, but rather as something that github.io can serve up, e.g. straight HTML or markdown that is transformed to HTML.

rvosa commented 7 years ago

I made a static website (here: https://nescent.github.io/community-and-code/). It makes extensive use of github's jekkyll integration, which means that there is essentially NO HTML behind it, it's all based on the markdown documents in the gh-pages branch and a single template.