From 2492cf1da9fde564c3aa2eb2a23ad30b8273bcac Mon Sep 17 00:00:00 2001
From: Nils Windisch <windisch@sub.uni-goettingen.de>
Date: Wed, 27 Jan 2021 11:38:04 +0100
Subject: [PATCH] docs: add content editing info

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/readme.md b/readme.md
index 5d67174..f8f4f38 100644
--- a/readme.md
+++ b/readme.md
@@ -9,3 +9,21 @@
 ## Todo
 
 - include TIDO viewer on pages syriac and arabic
+
+## Edit Content
+
+Page content can be found in various markdown files in [`src/`](https://gitlab.gwdg.de/subugoe/ahiqar/website/-/tree/main/src) and [`src/de/`](https://gitlab.gwdg.de/subugoe/ahiqar/website/-/tree/main/src/de).
+
+Gitlab's Web IDE can be used as well as a checkout-edit-locally-and-commit-workflow.
+
+You can either open a branch for edits and use [Gitlab's environment feature](https://gitlab.gwdg.de/subugoe/ahiqar/website/-/environments) to preview changes or use the master branch.
+
+Be aware that if you use Gitlab's web IDE the changelog can't reflect the changes. This is not ideal, so please go the checkout-edit-locally-and-commit-workflow route and don't skip commit hooks and use the approriate commit message category and write clear commit messages.
+
+Basically the general rules on how to format markdown apply, but to have it properly styled you have to use vuetify styles (see below). The general markdown formating rules are avialable e. g. [at Github](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
+
+To format content blocks take the [vuetify UI library styles](https://vuetifyjs.com/en/getting-started/) *(look for "Styles and animations" in the left menu)* as a reference - e.g. [vuetify typography reference](https://vuetifyjs.com/en/styles/text-and-typography/).
+
+If you want to get an idea why things look the way they look already, peek into existing files and inspect the { } parts - [like here at the homepage](https://gitlab.gwdg.de/subugoe/ahiqar/website/-/blob/main/src/index.md).
+
+Images and files can be added too, a description on how to do that is not neccessary atm, since it's not a project requirement.
-- 
GitLab