├── .travis.yml ├── .whitesource ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md ├── LICENSE └── README.md /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 2.2 3 | before_script: gem install awesome_bot 4 | script: awesome_bot README.md --allow-dupe --allow-redirect 5 | -------------------------------------------------------------------------------- /.whitesource: -------------------------------------------------------------------------------- 1 | ########################################################## 2 | #### WhiteSource "Bolt for Github" configuration file #### 3 | ########################################################## 4 | 5 | # Configuration # 6 | #---------------# 7 | ws.repo.scan=true 8 | vulnerable.check.run.conclusion.level=failure 9 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | You can share your templates or implementations by reporting an [issue](https://github.com/derberg/docu-based-on-static-site-generators/issues) or by submitting a [pull request](https://github.com/derberg/docu-based-on-static-site-generators/pulls). For now there are no strict rules as any contribution will actually be appriciated. 2 | -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | You want to add a new link to the list? 2 | This is what I need: 3 | 4 | - link to repository/sources of the project 5 | - indication what it is? theme/template/skeleton or a ready implementation of some portal 6 | - name of the static site generator that is used under the hood 7 | - write if you do not want to be explicitly named as a contributor 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal (CC0 1.0) Public Domain Dedication 2 | 3 | [CC0](https://creativecommons.org/publicdomain/zero/1.0/) 4 | 5 | The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law. 6 | 7 | You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission. See Other Information below. 8 | 9 | In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. 10 | Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. 11 | When using or citing the work, you should not imply endorsement by the author or the affirmer. 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome Docs with Static Site Generators [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Build Status](https://travis-ci.org/derberg/awesome-docs-with-static-site-generators.svg?branch=master)](https://travis-ci.org/derberg/awesome-docs-with-static-site-generators) 2 | 3 | ### Table of Contents 4 | 5 | * [Short Story](#short-story) 6 | * [About](#about) 7 | * [Static Site Generators](#static-site-generators) 8 | * [DocPad](#docpad) 9 | * [Jekyll](#jekyll) 10 | * [Nanoc](#nanoc) 11 | * [Hugo](#hugo) 12 | * [Gatsby](#gatsby) 13 | * [Middleman](#middleman) 14 | * [Sphinx](#sphinx) 15 | * [Hexo](#hexo) 16 | * [Dactyl](#dactyl) 17 | 18 | ## Short Story 19 | 20 | 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. 21 | 22 | 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. 23 | 24 | ## About 25 | 26 | 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. 27 | 28 | 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. 29 | 30 | ## Static Site Generators 31 | 32 | * Short explanation: Tools to generate a web page that you can host for free using services like [GitHub Pages](https://pages.github.com/). 33 | * Bigger explanation [here](https://davidwalsh.name/introduction-static-site-generators) 34 | * Over 400 of them. Listed [here](https://staticsitegenerators.net/) and [here](https://www.staticgen.com/). 35 | 36 | ### [DocPad](https://docpad.org/) 37 | 38 | * https://github.com/YaaS/docpad-skeleton-apidocs [template/skeleton/theme] 39 | * https://github.com/fluid-project/docs-template [template/skeleton/theme] 40 | * https://github.com/liferay/alloyui.com [implementation] 41 | * https://github.com/bevry/docpad-website [implementation] 42 | * https://github.com/fluid-project/infusion-docs [implementation] 43 | 44 | ### [Jekyll](https://jekyllrb.com/) 45 | 46 | * https://github.com/Wiredcraft/carte [sample] 47 | * https://github.com/tomjohnson1492/documentation-theme-jekyll [template/skeleton/theme] 48 | * https://github.com/twbs/bootstrap [implementation] 49 | * https://github.com/strongloop/loopback.io [implementation] 50 | * https://github.com/Dwolla/open-source-developer-portal [implementation] 51 | * https://github.com/apache/incubator-openwhisk-website [implementation] 52 | * https://github.com/yarnpkg/website [implementation] 53 | * https://github.com/electron/electron.atom.io [implementation] 54 | 55 | ### [Nanoc](https://nanoc.ws/) 56 | 57 | * https://github.com/github-archive/developer.github.com [implementation] 58 | * https://github.com/nanoc/nanoc.ws [implementation] 59 | * https://github.com/flattr/developers.flattr.net/tree/master [implementation] 60 | * https://github.com/prometheus/docs [implementation] 61 | 62 | ### [Hugo](http://gohugo.io/) 63 | 64 | * https://github.com/kubernetes/website [implementation] 65 | * https://github.com/bep/docuapi [template/skeleton/theme] 66 | * https://github.com/key-amb/hugo-theme-bootie-docs [template/skeleton/theme] 67 | * https://github.com/digitalcraftsman/hugo-material-docs [template/skeleton/theme] 68 | * https://github.com/gohugoio/hugo/tree/master/docs [implementation] 69 | * https://github.com/matcornic/hugo-theme-learn [template/skeleton/theme] 70 | * https://github.com/digitalcraftsman/hugo-alabaster-theme/ [template/skeleton/theme] 71 | * https://github.com/adejoux/hugo-darkdoc-theme/ [template/skeleton/theme] 72 | * https://github.com/letsencrypt/website [implementation] 73 | * https://github.com/linode/docs [implementation] 74 | * https://github.com/livechat/livechat-public-docs [implementation] 75 | * https://github.com/jeblister/kube [theme] 76 | * https://github.com/gohugoio/gohugoioTheme [theme] 77 | 78 | ### [Gatsby](https://github.com/gatsbyjs/gatsby) 79 | 80 | * https://github.com/graphql-python/graphene/tree/master/docs [implementation] 81 | * https://github.com/reactjs/reactjs.org [implementation] 82 | 83 | ### [Middleman](https://middlemanapp.com/) 84 | 85 | * https://github.com/middleman/middleman-guides [template/skeleton/theme] 86 | * https://github.com/lord/slate [template/skeleton/theme] 87 | 88 | ### [Sphinx](http://www.sphinx-doc.org/) 89 | 90 | * https://github.com/snide/sphinx_rtd_theme [template/skeleton/theme] 91 | * https://github.com/bitprophet/alabaster [template/skeleton/theme] 92 | * https://github.com/ryan-roemer/sphinx-bootstrap-theme [template/skeleton/theme] 93 | * https://github.com/guzzle/guzzle_sphinx_theme [template/skeleton/theme] 94 | 95 | ### [Hexo](https://hexo.io/) 96 | 97 | * https://github.com/xcatliu/hexo-theme-wiki-i18n [template/skeleton/theme] and its implementation https://github.com/xcatliu/js-index 98 | 99 | ### [Dactyl](https://github.com/ripple/dactyl) 100 | 101 | * https://github.com/ripple/ripple-dev-portal [implementation] 102 | --------------------------------------------------------------------------------