website/readme.md
Andreas Hnida eeae6bc997
All checks were successful
Build and Deploy Hugo Site / buildAndDeploy (push) Successful in 1m41s
reverted changes for environment variable
2024-04-18 14:27:33 +02:00

3.2 KiB
Executable file
Raw Blame History

Verua.CH Website

currently under development on: verua.dev-1.andreashnida.de 👀

Development site: preview.verua.info
Production site: verua.info

This site is based on Hugoplate Boilerplate Theme for Hugo. For specifics on how to use the theme, please refer to the README of the theme.

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.

# Clone the repository
git clone https://code.verua.online/rabeweb/verua.ch_src.git

# connect to your gitea instance
cd verua.ch_src
git remote add origin https://code.verua.online/rabeweb/verua.ch_src.git
git push -u origin main

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.

You can control where the site is deployed by setting the 'environment' variable in the hugo.toml file. The value should be either production or development.

This also controls the creation of the robots.txt file. If the value is development, the robots.txt file will be created with the following content:

User-agent: *
Disallow: /

Credentials and targets are stored as secrets in your Gitea instance.

You can also run the site locally. Please refer to the 'Development' section for more information.

You will find the workflow file in /.gitea/workflows/build-and-deploy-pipeline.yaml

Development

To run the site locally, you can use the following commands:

# Install dependencies
npm install

# Start the development server
npm run dev

The site will be available at http://localhost:8080.

Features

Custom Shortcodes exclusively for Verua.CH

/themes/hugoplate/layouts/shortcodes/

  • Alerts: Create alerts with custom text and styles.
  • Aligncenter: Center content horizontally.
  • Buttons: Create buttons with custom text and styles.
  • Cards: Create beautiful cards with custom content and images.
  • Columns: Create responsive columns with custom content and images.
  • Icons: Use icons from the Font Awesome library to add icons to your website.
  • Sections: Create sections with custom content and images.