add doc on how to create or edit pages

This commit is contained in:
neri 2019-12-14 18:59:34 +01:00
parent b317cb06fb
commit 57250694c1
1 changed files with 35 additions and 86 deletions

121
README.md
View File

@ -1,97 +1,46 @@
<!-- AUTO-GENERATED-CONTENT:START (STARTER) --> # Ctdo Homepage
<p align="center">
<a href="https://www.gatsbyjs.org">
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
</a>
</p>
<h1 align="center">
Gatsby's hello-world starter
</h1>
Kick off your project with this hello-world boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React. ## Eine Seite bearbeiten
_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._ Klicke bei der Seite, die du bearbeiten möchtest unten im Footer auf "Seite bearbeiten".
Nimm im Editor der sich öffnet die gewünschten Änderungen vor.
Wie die Seiten aufgebaut sind steht unten in der Sektion Seitenlayout.
Wie du deine Änderung veröffentlichst steht in der Sektion Deploy.
## 🚀 Quick start ## Eine neue Seite erstellen
1. **Create a Gatsby site.** Um eine neue Seite zu erstellen lege eine neue Datei im `markdown-pages` Ordner
[hier](https://repos.ctdo.de/-/ide/project/neri/ctdo-hompage/tree/master/-/src/markdown-pages/) an.
Wie die Seite aufgebaut sein muss steht unten in der Sektion Seitenlayout.
Wie du deine Änderung veröffentlichst steht in der Sektion Deploy.
Use the Gatsby CLI to create a new site, specifying the hello-world starter. Um die neue Seite in die Navigation einzubinden füge ein neues Element in das Array `pages` in
[diese Datei](https://repos.ctdo.de/-/ide/project/neri/ctdo-hompage/blob/master/-/src/components/nav.js)
ein.
```shell ## Seitenlayout
# create a new Gatsby site using the hello-world starter
gatsby new my-hello-world-starter https://github.com/gatsbyjs/gatsby-starter-hello-world
```
1. **Start developing.** Eine Seite muss mit folgendem Header beginnen:
```
---
path: ""
title: ""
edit: ""
---
```
In `path` muss stehen, unter welchem Pfad die Seite auf der Webseite erscheint.
Für die Home-Seite ist dies beispielsweise "/", für die "Zeiten & Location"-Seite "/treff".
In `title` steht der Text der im Browsertab angezeigt werden soll wenn die Seite offen ist.
In `edit` muss der Name der angelegten Datei stehen, dieser wird verwendet,
damit der "Seite bearbeiten"-Link richtig funktioniert.
Navigate into your new sites directory and start it up. Darunter wird die Seite in [Markdown](https://www.markdownguide.org/cheat-sheet/) definiert.
Als Konvention werden auf der Seite keine `H1`, sondern erst `H2`-Überschriften verwendet.
```shell ## Deploy
cd my-hello-world-starter/
gatsby develop
```
1. **Open the source code and start editing!** Wenn du mit deinen Änderungen fertig bist,
klicke auf Commit und gib eine Beschreibung deiner Änderungen ein.
Ungefähr 30 Sekunden später sollten deine Änderungen auf der Website sichtbar sein.
Möglicherweise musst du einmal mit Shift+F5 deinen Browsercache ignorieren.
Your site is now running at `http://localhost:8000`!
_Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
Open the `my-hello-world-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
## 🧐 What's inside?
A quick look at the top-level files and directories you'll see in a Gatsby project.
.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins youd like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
9. **`LICENSE`**: Gatsby is licensed under the MIT license.
10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You wont change this file directly).**
11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the projects name, author, etc). This manifest is how npm knows which packages to install for your project.
12. **`README.md`**: A text file containing useful reference information about your project.
## 🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
## 💫 Deploy
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-hello-world)
<!-- AUTO-GENERATED-CONTENT:END -->