search

fgrehm / vagrant-cachier

Caffeine reducer
http://fgrehm.viewdocs.io/vagrant-cachier
MIT License
1.07k stars 111 forks source link

Create a proper docs website #56

Closed fgrehm closed 10 years ago

fgrehm commented 10 years ago

We actually started discussing this a while ago but we didn't talk much about it. Since then our README has grown too big and is about time for us to clean things up :)

I'm up for using some static site generator to do this like jekyll or middleman but I suck at UIs and I'd love to use some nice looking pre-made template.

What do you guys think?

gimler commented 10 years ago

alternative we can create a doc folder with the markdown files and use the github rendering. it is simplier also to update the content same repro but it is not really powerfull.

fgrehm commented 10 years ago

I think it is a great start actually, I was thinking about a fully blown website but we can start by moving things out of the readme and continue from there :)

patcon commented 10 years ago

@gimler++ big fan of keeping docs in the same repo and branch. Github's encouragement of this gh-page practice is really unfortunately in my opinion, because you can't enforce updated documentation as part of any pull request :)

fgrehm commented 10 years ago

Ok folks, I've found out about @progrium's brand new viewdocs project and I think we could use it here :)

What do you guys think?