{"id":26153360,"url":"https://github.com/kata-ai/grundgesetz-skeleton","last_synced_at":"2025-04-14T06:37:06.750Z","repository":{"id":36393186,"uuid":"133470904","full_name":"kata-ai/grundgesetz-skeleton","owner":"kata-ai","description":"You have a documentation. I turn it into a website. Any questions?","archived":false,"fork":false,"pushed_at":"2023-01-11T18:46:54.000Z","size":4613,"stargazers_count":43,"open_issues_count":21,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-27T20:22:22.675Z","etag":null,"topics":["documentation","gatsby","gatsby-starter","react","starter-kit","typescript"],"latest_commit_sha":null,"homepage":"https://grundgesetz-skeleton.now.sh/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kata-ai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-15T06:41:57.000Z","updated_at":"2023-11-15T19:15:25.000Z","dependencies_parsed_at":"2023-01-17T01:05:49.989Z","dependency_job_id":null,"html_url":"https://github.com/kata-ai/grundgesetz-skeleton","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-ai%2Fgrundgesetz-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-ai%2Fgrundgesetz-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-ai%2Fgrundgesetz-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kata-ai%2Fgrundgesetz-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kata-ai","download_url":"https://codeload.github.com/kata-ai/grundgesetz-skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248836291,"owners_count":21169370,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","gatsby","gatsby-starter","react","starter-kit","typescript"],"created_at":"2025-03-11T07:56:47.785Z","updated_at":"2025-04-14T06:37:06.697Z","avatar_url":"https://github.com/kata-ai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grundgesetz-skeleton\n\n\u003e You have a documentation. I turn it into a website. Any questions?\n\nWelcome to Grundgesetz. It's a skeleton for generating accessible documentation pages built on top of [Gatsby](https://www.gatsbyjs.org). It creates static pages from your Markdown documentation files, all prettily formatted with a easy-to-use layout.\n\nGrundgesetz is initially built to solve internal issues in managing documentation for our products at [Kata.ai](https://kata.ai/), but at the same we also found out that it's a good base for quickly deploying a documentation site online, so we put this up for everyone to use.\n\n## What's with the name?\n\nIt's German for \"constitution\". We had a thing for German codenames here at Kata.ai.\n\n## Who's using it?\n\n- [Kata Platform Documentation](https://docs.kata.ai/)\n- [TinaCMS](https://tinacms.org/docs/getting-started/introduction)\n- [Accelero](https://docs.accelero.io/)\n\n## Core Concepts\n\n### Just Your Docs\n\nGrundgesetz is set up for you to get up and running straight away. We know that writing proper documentation often takes a long time, so we aim to create this tool to standardise your documentation format.\n\nAll your docs are written in the familiar Markdown format and go inside the `/docs` folder. You can customise the table of contents and the header menu through a JSON file. It will generate pages with path names based on the directory tree, but you can override it anytime by setting a `permalink` frontmatter.\n\n### Instantly Deployable\n\nSince Grundgesetz is a static site generator, you can instantly deploy to any static web host.\n\nHave an instance of Grundgesetz set up on GitHub? You can easily deploy it using the built-in `deploy` task. You can also set up a continuous deployment pipeline for hosting providers like [Netlify](https://www.netlify.com/) or [Vercel](https://vercel.com/).\n\n### Blazing Fast\n\nGrundgesetz is built on top of Gatsby, a blazing-fast static site generator for React. Also, putting the words \"blazing fast\" into any project's README seems to attract a lot of folks lately. So I put it in here. Sorry.\n\nWant to learn more about Gatsby? [Click here](https://www.gatsbyjs.org).\n\n---\n\n## Geting Started\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/en/) (8.0.0+)\n- [Yarn](https://yarnpkg.com) (Optional. You can still use `npm` if you want, but this is for your own sanity.)\n\n### Initializing the Project\n\n#### The Fast Way\n\nYou can now create a new repository with Grundgesetz included by going to the GitHub page clicking on the \"Use this template\" button on the top right.\n\n![use-template](./static/img/use-template.png)\n\nThis will take you to the Create Repository screen. Fill in the details of your projects, and click \"Create repository from template\".\n\n![new-repo-from-template](./static/img/new-repo-from-template.png)\n\nOnce the repository is created, you can [clone the repository](https://help.github.com/en/articles/cloning-a-repository) and open your terminal in the repository's folder. Once you're there, install the dependencies by running `yarn` (or `npm install`, if you prefer to use npm).\n\n#### Using Gatsby CLI\n\nAlternatively, you can bootstrap your project using `gatsby-cli`. To install it, run the following command.\n\n```bash\n# npm\nnpm install -g gatsby-cli\n# yarn\nyarn global add gatsby-cli\n```\n\nNow we have `gatsby-cli` installed, we can now create a project based on the Grundgesetz skeleton by running:\n\n```bash\ngatsby new project-name https://github.com/kata-ai/grundgesetz-skeleton\n```\n\nThe project is generated in the folder with the `project-name` you specified. In the next section, we will start writing our documentation on-the-fly with the development server.\n\n### Running the server\n\nNow that we have the project set up, let's `cd` to the generated project. Here we'll have to install our node dependencies. To do so, run the following command.\n\n```bash\n# npm\nnpm install\n# yarn\nyarn\n```\n\nTo start working on our documentation, we need to start a development server.\n\n```bash\n# npm\nnpm dev\n# yarn\nyarn dev\n```\n\nThe command above will start a development server with hot-reloading capabilities on `localhost:8000`. From now on, you can start writing your documentation with ease.\n\nRead the [docs](https://grundgesetz-skeleton.kata-ai.now.sh/getting-started/deploying) for tips on how to deploy your new docs website to production.\n\n## Credits\n\nBuilt with [Gatsby](https://www.gatsbyjs.org/) - the blazing-fast static site generator for [React](https://facebook.github.io/react/).\n\n## Authors\n\n- Resi Respati ([@resir014](https://twitter.com/resir014)) – [Kata.ai](https://kata.ai)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkata-ai%2Fgrundgesetz-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkata-ai%2Fgrundgesetz-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkata-ai%2Fgrundgesetz-skeleton/lists"}