/gatsby-wiki

A wiki site template for gatsby

Primary LanguageJavaScriptMIT LicenseMIT

Gatsby

Gatsby Wiki Theme

A wiki theme for markdown driven documentation sites using Gatsby.

Motivation

I wanted a gatsby driven documentation platform that is dead-simple to contribute to (provided that you know how to use git and markdown 😬).

This project is primarily developer focused but it is open to contributions and suggestions from anyone who wants to use a gatsby-powered documentation site!

Demo

Netlify Hosted Demo

Features

  • Gatsby V2 Support
  • Gatsby blog starter structure
    • With modifications, detailed below
  • Markdown post support
  • Hierarchical post navigation
    • Automatically generated from the filesystem (your posts!)
    • Displayed via Kendo UI TreeView

Todo (in no particular order)

  • Automatic transformation of posts into wiki pages
  • Auto-generated navigation tree
  • Responsive sidebar
  • Responsive post content
  • Friendly customization API (paths/prefixes, file locations, theming, etc)
  • Higher quality src code for friendlier modification
  • Unit testing
  • Builds / Build status / CI / CD
  • Your suggestions ❤️

Getting Started

This repo is a Gatsby Theme

Follow the instructions here to install a handy starter that implements this theme!