diff --git a/README.md b/README.md new file mode 100644 index 0000000..6de4490 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Rezeptschneider + +Eine Sammlung verschiedener Rezepte. Jetzt auch open source! + +## Mitmachen + +Das Repo clonen, Beitrag erstellen oder editieren und dann einen Pull Request eröffnen. + +### Beitrag erstellen + +Die Seite wird mit [Hugo](https://gohugo.io) generiert. Die Beiträge liegen im Ordner [content/posts](/schneider/rezeptschneider/src/branch/master/content/posts). Das generelle Format ist markdown, die ersten Zeilen gehören allerdings zum [Front Matter](https://gohugo.io/content-management/front-matter/). Dort werden Metadaten des Beitrages gespeichert. Guckt auch einfach mal in die bestehenden Beiträge. + +Das Grundgerüst eines neuen Beitrages lässt sich auch mit `hugo` generieren, wenn es installiert ist. +Dann kann per `hugo new posts/mein-tolles-rezept.md` ein neuer Beitrag erstellt werden. +Eine Vorschau ist per `hugo server -D` erhältlich. \ No newline at end of file