https://github.com/cephalization/gatsby-starter-wiki-theme
A simple gatsby theme to get up and writing markdown documentation quickly, with GatsbyJS
https://github.com/cephalization/gatsby-starter-wiki-theme
Last synced: 11 months ago
JSON representation
A simple gatsby theme to get up and writing markdown documentation quickly, with GatsbyJS
- Host: GitHub
- URL: https://github.com/cephalization/gatsby-starter-wiki-theme
- Owner: cephalization
- License: mit
- Created: 2019-02-02T05:05:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-02T05:16:37.000Z (over 7 years ago)
- Last Synced: 2025-06-07T13:44:24.907Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 329 KB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gatsby Starter Wiki Theme
A gatsby wiki starter / theme for markdown driven documentation sites using [Gatsby](https://github.com/gatsbyjs/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!
## How is this different from a normal gatsby starter?
This project is a [Gatsby Starter](https://www.gatsbyjs.org/starters/?v=2) that implements [gatsby theming](https://www.gatsbyjs.org/blog/2018-11-11-introducing-gatsby-themes/).
This means that all of the core functionality of this starter can be _updated_ via npm whenever it gains new features!
Gatsby starters typically hold all of the feature code, which means that when you create a Gatsby site from a starter you diverge from the master branch. This makes it really hard to get the new features of a starter when they are updated without doing complicated merges.
## Demo
[Netlify Hosted Demo](https://blissful-euler-14b462.netlify.com/)
## Features
- Gatsby V2 Support
- Main features implemented via Gatsby Theming ([What does this mean?](https://www.gatsbyjs.org/blog/2018-11-11-introducing-gatsby-themes/))
- 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](https://www.telerik.com/kendo-react-ui/components/treeview/)
## Todo (in no particular order)
[See sister theme repository (all of the Gatsby code lives here!)](https://github.com/cephalization/gatsby-wiki)
## Getting Started
```
# Install gatsby-cli
npm install --global gatsby-cli
# Create a new Gatsby site from this starter
# (Change `my-new-wiki` to whatever you want your wiki to be called)
gatsby new my-new-wiki https://github.com/cephalization/gatsby-starter-wiki-theme
# Run the wiki locally
npm run start
```
You can now host this template via your favorite hosting service (or yourself!), push to your own git repo, and customize to your heart's content!
## Adding new articles
1. Create md file in `wiki//.md`
- Keep in mind, whatever directory structure you make here will be the link of the post!
2. Setup frontmatter (special markdown header) at the top of the file like so:
```
---
title: 'My First Post!'
path: '//.md'
---
```
3. Add post content 👌
```
---
title: 'My First Post!'
path: '//.md'
---
# How to add posts
First you must read the README...
```
4. Restart your server
## Customizing Gatsby Theme
More detailed instructions will come later, for now, refer to [this](https://github.com/ChristopherBiscardi/gatsby-theme-examples)