lewisacidic / awesome-docs-with-static-site-generators

Pointers to all templates and implementations based on static site generators

Awesome Docs with Static Site Generators

Table of Contents

• Short Story
• About
• Static Site Generators
  • DocPad
  • Jekyll
  • Nanoc
  • Hugo
  • Gatsby
  • Middleman
  • Sphinx
  • Hexo
  • Dactyl

Short Story

I believe that the best way of learn things is to play with them. Learning by example first, then reading and learning more details and theory. I think it's mainly because I'm to dumb to understand the idea or any concept even if it's well described. If I was a Neanderthalian and somebody tried to explain to me what fire is, I would never understand it. I would have to light it on my own few times, get my first burns and first grilled zucchini.

What I'm trying to explain here is ... :) that my adventure with static site generators started, because I could use somebody's work. I could play with it and quickly see what I can do and to quickly set up a sample that I could present in my company to drive a change. Now you have all the links in one place, you don't have to spend to much time on research.

About

This repo is suppose to give you a bunch of links to themes or ready implementations of documentation portals. They will help you to quickly get some good samples to play with a static site generator that you are interested with.

Why not just templates only? Simply because basing on my experience it is sometimes also good to learn on ready implementations. This is how I understood what generators are. I played with https://github.com/Wiredcraft/carte [Jekyll] and https://github.com/liferay/alloyui.com [DocPad] first, and prepared a proof of concept by setting up the second one locally with my own content.

Static Site Generators

• Short explanation: Tools to generate a web page that you can host for free using services like GitHub Pages.
• Bigger explanation here
• Over 400 of them. Listed here and here.

DocPad

• https://github.com/YaaS/docpad-skeleton-apidocs [template/skeleton/theme]
• https://github.com/fluid-project/docs-template [template/skeleton/theme]
• https://github.com/liferay/alloyui.com [implementation]
• https://github.com/bevry/docpad-website [implementation]
• https://github.com/fluid-project/infusion-docs [implementation]

Jekyll

• https://github.com/Wiredcraft/carte [sample]
• https://github.com/tomjohnson1492/documentation-theme-jekyll [template/skeleton/theme]
• https://github.com/twbs/bootstrap [implementation]
• https://github.com/strongloop/loopback.io [implementation]
• https://github.com/Dwolla/open-source-developer-portal [implementation]
• https://github.com/apache/incubator-openwhisk-website [implementation]
• https://github.com/yarnpkg/website [implementation]
• https://github.com/electron/electron.atom.io [implementation]

Nanoc

• https://github.com/github-archive/developer.github.com [implementation]
• https://github.com/nanoc/nanoc.ws [implementation]
• https://github.com/flattr/developers.flattr.net/tree/master [implementation]
• https://github.com/prometheus/docs [implementation]

Hugo

• https://github.com/kubernetes/website [implementation]
• https://github.com/bep/docuapi [template/skeleton/theme]
• https://github.com/key-amb/hugo-theme-bootie-docs [template/skeleton/theme]
• https://github.com/digitalcraftsman/hugo-material-docs [template/skeleton/theme]
• https://github.com/gohugoio/hugo/tree/master/docs [implementation]
• https://github.com/matcornic/hugo-theme-learn [template/skeleton/theme]
• https://github.com/digitalcraftsman/hugo-alabaster-theme/ [template/skeleton/theme]
• https://github.com/adejoux/hugo-darkdoc-theme/ [template/skeleton/theme]
• https://github.com/letsencrypt/website [implementation]
• https://github.com/linode/docs [implementation]
• https://github.com/livechat/livechat-public-docs [implementation]
• https://github.com/jeblister/kube [theme]
• https://github.com/gohugoio/gohugoioTheme [theme]

Gatsby

• https://github.com/graphql-python/graphene/tree/master/docs [implementation]
• https://github.com/reactjs/reactjs.org [implementation]

Middleman

• https://github.com/middleman/middleman-guides [template/skeleton/theme]
• https://github.com/lord/slate [template/skeleton/theme]

Sphinx

• https://github.com/snide/sphinx_rtd_theme [template/skeleton/theme]
• https://github.com/bitprophet/alabaster [template/skeleton/theme]
• https://github.com/ryan-roemer/sphinx-bootstrap-theme [template/skeleton/theme]
• https://github.com/guzzle/guzzle_sphinx_theme [template/skeleton/theme]

Hexo

• https://github.com/xcatliu/hexo-theme-wiki-i18n [template/skeleton/theme] and its implementation https://github.com/xcatliu/js-index

Dactyl

• https://github.com/ripple/ripple-dev-portal [implementation]