rabeweb/website
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ToC
All checks were successful
Build and Deploy Hugo Site / buildAndDeploy (push) Successful in 1m42s
Details

Browse source
This commit is contained in:
Andreas Hnida 2024-04-18 15:00:36 +02:00
commit ab1caf903a
1 changed files with 29 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

33
readme.md
View file

@ -21,9 +21,9 @@ Production site: <a target="_blank" href="https://verua.info/" rel="nofollow">ve
## Table of Contents ## Table of Contents
- [Usage / Update Content](#usage--update-content) - [Usage / Update Content](#usage--update-content)
- [Editing Content](#editing-content) - [Editing Content](#editing-content)
- [Images](#images) - [Images](#images)
- [Shortcodes](#shortcodes) - [Shortcodes](#shortcodes)
- [Custom Shortcodes exclusively for VeruA.ch](#custom-shortcodes-exclusively-for-veruach) - [Custom Shortcodes exclusively for VeruA.ch](#custom-shortcodes-exclusively-for-veruach)
- [Alert](#alert) - [Alert](#alert)
- [Aligncenter](#aligncenter) - [Aligncenter](#aligncenter)
@ -34,6 +34,7 @@ Production site: <a target="_blank" href="https://verua.info/" rel="nofollow">ve
- [Deployment](#deployment) - [Deployment](#deployment)
- [Development](#development) - [Development](#development)
[⬆](#table-of-contents)
## Usage / Update Content ## Usage / Update Content
@ -49,6 +50,8 @@ git remote add origin https://code.verua.online/rabeweb/verua.ch_src.git
git push -u origin main git push -u origin main
``` ```
[⬆](#table-of-contents)
### Editing Content ### 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. 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.
@ -62,18 +65,24 @@ 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`. 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`.
[⬆](#table-of-contents)
### Images ### Images
Images are stored in the `static/images` folder. You can use the `![]()` syntax to insert images into your markdown files. 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: `![](images/my-image.png)`. 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: `![](images/my-image.png)`.
[⬆](#table-of-contents)
### Shortcodes ### 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). 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. 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.
[⬆](#table-of-contents)
## Custom Shortcodes exclusively for VeruA.ch ## Custom Shortcodes exclusively for VeruA.ch
<small>/themes/hugoplate/layouts/shortcodes/</small> <small>/themes/hugoplate/layouts/shortcodes/</small>
@ -85,6 +94,8 @@ 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. - **Icons**: Use icons from the Font Awesome library to add icons to your website.
- **Sections**: Create sections with custom content and images. - **Sections**: Create sections with custom content and images.
[⬆](#table-of-contents)
### Alert ### Alert
The alert shortcode is used to create alerts with custom text and styles. The alert shortcode is used to create alerts with custom text and styles.
@ -97,6 +108,8 @@ Content
`{{% /alert %}}` `{{% /alert %}}`
[⬆](#table-of-contents)
### Aligncenter ### Aligncenter
The aligncenter shortcode is used to center content horizontally. The aligncenter shortcode is used to center content horizontally.
@ -109,6 +122,8 @@ Content
`{{% /aligncenter %}}` `{{% /aligncenter %}}`
[⬆](#table-of-contents)
### Card ### Card
The card shortcode is used to create beautiful cards with custom content and images. The card shortcode is used to create beautiful cards with custom content and images.
@ -135,6 +150,8 @@ Kann ein `Title` - Attribut haben:
` `
[⬆](#table-of-contents)
### Columns ### Columns
**Pfad:** themes/hugoplate/layouts/shortcodes/columns.html **Pfad:** themes/hugoplate/layouts/shortcodes/columns.html
@ -155,6 +172,8 @@ Content
`{{% /columns %}}` `{{% /columns %}}`
[⬆](#table-of-contents)
## Font-Awesome Icon ## Font-Awesome Icon
`{{% icon name="user" color="black" size="5xl" %}}` `{{% icon name="user" color="black" size="5xl" %}}`
@ -168,6 +187,8 @@ text-gray-50 -> color="gray-50"
text-5xl -> size="5xl" text-5xl -> size="5xl"
[⬆](#table-of-contents)
### Section ### Section
It is a good idea to use the section shortcode to separate your content into sections and keep consistent margins and page widths. It is a good idea to use the section shortcode to separate your content into sections and keep consistent margins and page widths.
@ -184,6 +205,8 @@ Kann ein `Background` - Attribut haben:
`{{% section background="images/startseite-slide.jpg" %}}` `{{% section background="images/startseite-slide.jpg" %}}`
[⬆](#table-of-contents)
## Deployment ## 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. 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.
@ -203,6 +226,8 @@ 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` ℹ You will find the workflow file in `/.gitea/workflows/build-and-deploy-pipeline.yaml`
[⬆](#table-of-contents)
## Development ## Development
To run the site locally, you can use the following commands: To run the site locally, you can use the following commands:
@ -215,4 +240,4 @@ npm install
npm run dev npm run dev
``` ```
The site will be available at `http://localhost:8080`. The site will be available at `http://localhost:8080`.