{"componentChunkName":"component---src-templates-page-tsx","path":"/getting-started/installation/","result":{"data":{"site":{"siteMetadata":{"title":"Grundgesetz","description":"Zero-configuration documentation builder, powered by Gatsby.","siteUrl":"https://grundgesetz-skeleton.netlify.com","keywords":"gatsbyjs, gatsby, documentation, sample project","author":{"name":"Resi Respati","url":"https://resir014.xyz","email":"resi@kata.ai"}}},"sectionList":{"edges":[{"node":{"title":"Getting Started","items":[{"id":"installation","slug":"/getting-started/installation","title":"Installation"},{"id":"development-server","slug":"/getting-started/development-server","title":"Development Server"},{"id":"deploying","slug":"/getting-started/deploying","title":"Deploying"}]}},{"node":{"title":"Writing","items":[{"id":"project-structure","slug":"/writing/project-structure","title":"Project Structure"},{"id":"table-of-contents","slug":"/writing/table-of-contents","title":"Table of Contents"},{"id":"writing-in-markdown","slug":"/writing/writing-in-markdown","title":"Writing in Markdown"}]}},{"node":{"title":"Theming","items":[{"id":"theming-overview","slug":"/theming/overview","title":"Overview"},{"id":"theming-variables","slug":"/theming/variables","title":"Variables"},{"id":"theming-helper-components","slug":"/theming/helper-components","title":"Helper Components"}]}}]},"markdownRemark":{"htmlAst":{"type":"root","children":[{"type":"element","tagName":"h2","properties":{"id":"prerequisites","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#prerequisites","ariaLabel":"prerequisites permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Prerequisites"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Grundgesetz is built on top of "},{"type":"element","tagName":"a","properties":{"href":"https://www.gatsbjs.org"},"children":[{"type":"text","value":"Gatsby"}]},{"type":"text","value":". To run all the tools required you need at least the following:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"a","properties":{"href":"https://nodejs.org/en/"},"children":[{"type":"text","value":"Node.js"}]},{"type":"text","value":" (8.0.0+)"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"a","properties":{"href":"https://yarnpkg.com"},"children":[{"type":"text","value":"Yarn"}]},{"type":"text","value":" (Optional. You can still use "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"npm"}]},{"type":"text","value":" if you want, but this is for your own sanity.)"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"initializing-the-project","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#initializing-the-project","ariaLabel":"initializing the project permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Initializing the Project"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"the-fast-way","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#the-fast-way","ariaLabel":"the fast way permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"The Fast Way"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"You 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."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"img","properties":{"src":"/img/use-template.png","alt":"use-template"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"This will take you to the Create Repository screen. Fill in the details of your projects, and click “Create repository from template”."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"img","properties":{"src":"/img/new-repo-from-template.png","alt":"new-repo-from-template"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Once the repository is created, you can "},{"type":"element","tagName":"a","properties":{"href":"https://help.github.com/en/articles/cloning-a-repository"},"children":[{"type":"text","value":"clone the repository"}]},{"type":"text","value":" and open your terminal in the repository’s folder. Once you’re there, install the dependencies by running "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"yarn"}]},{"type":"text","value":" (or "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"npm install"}]},{"type":"text","value":", if you prefer to use npm)."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h3","properties":{"id":"using-gatsby-cli","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#using-gatsby-cli","ariaLabel":"using gatsby cli permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Using Gatsby CLI"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Alternatively, you can bootstrap your project using "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"gatsby-cli"}]},{"type":"text","value":". To install it, run the following command."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["gatsby-highlight"],"dataLanguage":"bash"},"children":[{"type":"element","tagName":"pre","properties":{"className":["language-bash"]},"children":[{"type":"element","tagName":"code","properties":{"className":["language-bash"]},"children":[{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"# npm"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"span","properties":{"className":["token","function"]},"children":[{"type":"text","value":"npm"}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","function"]},"children":[{"type":"text","value":"install"}]},{"type":"text","value":" -g gatsby-cli\n"},{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"# yarn"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"span","properties":{"className":["token","function"]},"children":[{"type":"text","value":"yarn"}]},{"type":"text","value":" global "},{"type":"element","tagName":"span","properties":{"className":["token","function"]},"children":[{"type":"text","value":"add"}]},{"type":"text","value":" gatsby-cli"}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Now we have "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"gatsby-cli"}]},{"type":"text","value":" installed, we can now create a project based on the Grundgesetz skeleton by running:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["gatsby-highlight"],"dataLanguage":"bash"},"children":[{"type":"element","tagName":"pre","properties":{"className":["language-bash"]},"children":[{"type":"element","tagName":"code","properties":{"className":["language-bash"]},"children":[{"type":"text","value":"gatsby new project-name https://github.com/kata-ai/grundgesetz-skeleton"}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The project is generated in the folder with the "},{"type":"element","tagName":"code","properties":{"className":["language-text"]},"children":[{"type":"text","value":"project-name"}]},{"type":"text","value":" you specified. In the next section, we will start writing our documentation on-the-fly with the development server."}]}],"data":{"quirksMode":false}},"tableOfContents":"<ul>\n<li><a href=\"/getting-started/installation/#prerequisites\">Prerequisites</a></li>\n<li>\n<p><a href=\"/getting-started/installation/#initializing-the-project\">Initializing the Project</a></p>\n<ul>\n<li><a href=\"/getting-started/installation/#the-fast-way\">The Fast Way</a></li>\n<li><a href=\"/getting-started/installation/#using-gatsby-cli\">Using Gatsby CLI</a></li>\n</ul>\n</li>\n</ul>","excerpt":"Prerequisites Grundgesetz is built on top of Gatsby. To run all the tools required you need at least the following: Node.js (8.0.0+) Yarn…","frontmatter":{"id":"installation","title":"Installation","prev":null,"next":"development-server"}}},"pageContext":{"slug":"/getting-started/installation/"}}}