Grundgesetz Skeleton
You have a documentation. I turn it into a website. Any questions?
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
Prerequisites
- Node.js (8.0.0+)
- Yarn (optional, can use npm instead)
Initializing the Project
The Fast Way
- Go to the GitHub page for Grundgesetz and click on the "Use this template" button on the top right.
- Fill in the details of your project on the Create Repository screen and click "Create repository from template".
- Clone the repository and open your terminal in the repository's folder.
- Install the dependencies by running
yarn(ornpm installif preferred).
Using Gatsby CLI
- Install Gatsby CLI by running the following command.
npm install -g gatsby-cli
- 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.
- Gatsby
GatsbyJS is a free and open-source static site generator based on React. It uses a modern development stack including Webpack, GraphQL, and modern JavaScript and CSS frameworks. It also provides a rich set of plugins, starters, and themes.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Styled Components
Styled Components is a popular library for styling React components using CSS syntax. It allows you to write CSS in your JavaScript code, making it easier to create dynamic styles that are specific to each component.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- GitHub Pages
Gridsome is a Vue.js-based static site generator that makes it easy to build fast and flexible websites and applications by leveraging modern web technologies like GraphQL, Webpack, and hot reloading
- Prism JS
PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.