diff --git a/readme.md b/readme.md
index 004c7d7..645cde0 100755
--- a/readme.md
+++ b/readme.md
@@ -21,9 +21,9 @@ Production site: ve
## Table of Contents
- [Usage / Update Content](#usage--update-content)
- - [Editing Content](#editing-content)
- - [Images](#images)
- - [Shortcodes](#shortcodes)
+ - [Editing Content](#editing-content)
+ - [Images](#images)
+ - [Shortcodes](#shortcodes)
- [Custom Shortcodes exclusively for VeruA.ch](#custom-shortcodes-exclusively-for-veruach)
- [Alert](#alert)
- [Aligncenter](#aligncenter)
@@ -34,7 +34,8 @@ Production site: ve
- [Deployment](#deployment)
- [Development](#development)
-## Usage / Update Content [⬆](#table-of-contents)
+
+## Usage / Update Content
To use the theme, and to update your content, you need to clone the repository, update your content in the `content` folder and push your changes to the main branch which will trigger a deployment.
@@ -48,7 +49,7 @@ git remote add origin https://code.verua.online/rabeweb/verua.ch_src.git
git push -u origin main
```
-### Editing Content [⬆](#table-of-contents)
+### Editing Content
The content is written in the [markdown](https://www.markdownguide.org/getting-started/) format. You also use html tags to format your content but the ending still stays .md for markdown. These files are found in the `content` folder. For linking german and french content, you use the translation key syntax. This means that you put a key in the frontmatter of both files you want to link to.
@@ -61,19 +62,19 @@ translationKey: 'a-page-about-cats'
For example, the german version of the VeruA.ch website is located in the `content/german` folder. The french version is located in the `content/french` folder. Both are linked by the translation key `a-page-about-cats`.
-### Images [⬆](#table-of-contents)
+### Images
Images are stored in the `static/images` folder. You can use the `![]()` syntax to insert images into your markdown files.
Everything that is in the `static/images` folder will be copied to the `public/images` folder during the build process. This means that you can use relative paths to your images in your markdown files like this: ``.
-### Shortcodes [⬆](#table-of-contents)
+### Shortcodes
You can use shortcodes to add custom functionality to your markdown files. You can find a list of available shortcodes in the [Hugoplate documentation](https://github.com/zeon-studio/hugoplate/blob/main/README.md#shortcodes).
There are some shortcodes that are specific to the VeruA.ch website. These Shortcodes are defined in the `layouts/shortcodes` folder. You can find a list of available exclusive shortcodes like columns and sections further down in this document.
-## Custom Shortcodes exclusively for VeruA.ch [⬆](#table-of-contents)
+## Custom Shortcodes exclusively for VeruA.ch
/themes/hugoplate/layouts/shortcodes/
@@ -84,7 +85,7 @@ There are some shortcodes that are specific to the VeruA.ch website. These Short
- **Icons**: Use icons from the Font Awesome library to add icons to your website.
- **Sections**: Create sections with custom content and images.
-### Alert [⬆](#table-of-contents)
+### Alert
The alert shortcode is used to create alerts with custom text and styles.
@@ -96,7 +97,7 @@ Content
`{{% /alert %}}`
-### Aligncenter [⬆](#table-of-contents)
+### Aligncenter
The aligncenter shortcode is used to center content horizontally.
@@ -108,7 +109,7 @@ Content
`{{% /aligncenter %}}`
-### Card [⬆](#table-of-contents)
+### Card
The card shortcode is used to create beautiful cards with custom content and images.
@@ -134,7 +135,7 @@ Kann ein `Title` - Attribut haben:
`
-### Columns [⬆](#table-of-contents)
+### Columns
**Pfad:** themes/hugoplate/layouts/shortcodes/columns.html
@@ -154,7 +155,7 @@ Content
`{{% /columns %}}`
-## Font-Awesome Icon [⬆](#table-of-contents)
+## Font-Awesome Icon
`{{% icon name="user" color="black" size="5xl" %}}`
@@ -167,7 +168,7 @@ text-gray-50 -> color="gray-50"
text-5xl -> size="5xl"
-### Section [⬆](#table-of-contents)
+### Section
It is a good idea to use the section shortcode to separate your content into sections and keep consistent margins and page widths.
@@ -183,7 +184,7 @@ Kann ein `Background` - Attribut haben:
`{{% section background="images/startseite-slide.jpg" %}}`
-## Deployment [⬆](#table-of-contents)
+## Deployment
Deployment is done via Gitea Runners. The deployment is triggered by a push to the `main` branch. The deployment will automatically build the site and deploy it to the production or preview environment.
@@ -202,7 +203,7 @@ You can also run the site locally. Please refer to the 'Development' section for
ℹ You will find the workflow file in `/.gitea/workflows/build-and-deploy-pipeline.yaml`
-## Development [⬆](#table-of-contents)
+## Development
To run the site locally, you can use the following commands:
@@ -214,4 +215,4 @@ npm install
npm run dev
```
-The site will be available at `http://localhost:8080`.
+The site will be available at `http://localhost:8080`.
\ No newline at end of file