Grundgesetz Skeleton

Overview

The Grundgesetz skeleton is a tool built on top of Gatsby that generates static documentation pages from Markdown files. It was initially created to address internal issues with managing documentation at Kata.ai but is now available for anyone to use. The name “Grundgesetz” is German for “constitution” and was chosen as a codename. The tool is being used by several organizations, including Kata Platform Documentation, TinaCMS, AcceleroCore Concepts, and Just Your Docs. Grundgesetz aims to standardize documentation format and provides a customizable table of contents and header menu through a JSON file. It is easy to deploy to any static web host and offers fast performance due to its use of Gatsby.

Features

• Generates static documentation pages from Markdown files
• Customizable table of contents and header menu through a JSON file
• Easy deployment to any static web host
• Fast performance using Gatsby

Installation

Prerequisites

• Node.js (8.0.0+)
• Yarn (optional, can use npm instead)

Initializing the Project

The Fast Way

1. Go to the GitHub page for Grundgesetz and click on the “Use this template” button on the top right.
2. Fill in the details of your project on the Create Repository screen and click “Create repository from template”.
3. Clone the repository and open your terminal in the repository’s folder.
4. Install the dependencies by running yarn (or npm install if preferred).

Using Gatsby CLI

1. Install Gatsby CLI by running the following command.

npm install -g gatsby-cli

2. Create a project based on the Grundgesetz skeleton by running:

gatsby new project-name https://github.com/kata-ai/grundgesetz-skeleton

Replace “project-name” with your desired name.

Running the server

Once the project is set up, you can start writing documentation using the development server.

Summary

The Grundgesetz skeleton is a tool built on top of Gatsby that generates static documentation pages from Markdown files. It offers customizable features such as a table of contents and header menu. The tool is easy to install and deploy, and it provides fast performance.