MacGapProject / MacGap1

Desktop WebKit wrapper for HTML/CSS/JS applications.
Other
3.55k stars 208 forks source link

Better documentation system #128

Closed jeff-h closed 10 years ago

jeff-h commented 10 years ago

I think our documentation browser could be a lot better than GitHub wiki allows. For example, check out http://docs.jetstrap.com. They wrote an article about how they did this at http://blog.jetstrap.com/2013/03/building-a-docs-site-with-jekyll-github-pages/

By comparison, the layout/design of my first very rough pass at documenting MacGap 2's API is dreadful! https://github.com/rawcreative/MacGap2/wiki/MacGap

Anyone have any ideas? I really want something where:

rawcreative commented 10 years ago

Just use this template as a starting point: http://bruth.github.io/jekyll-docs-template/

rawcreative commented 10 years ago

I've created a gh-pages branch just for docs on the temp MG2 repo with a jekyll site and some basic styling.. It probably makes sense to have each of the repos have it's own gh-pages docs branch and keep the org pages for the main site.

jeff-h commented 10 years ago

You're unstoppable! :D This is beautiful — exactly what I was looking for. Unfortunately I can't write to this repo where it is — so I can't work on the docs site just yet. Are you happy to shift it over to MacGapProject soonish? We can stick a note on it to say that it's in alpha if you like.

rawcreative commented 10 years ago

Done

jeff-h commented 10 years ago

Good times :)