Skip to content
Snippets Groups Projects
Commit cddf35d1 authored by Thorge Petersen's avatar Thorge Petersen
Browse files

Merge branch 'stage' into main

parents cc25c919 b0a823ed
No related branches found
No related tags found
No related merge requests found
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2023-05-26
### Added
- Implemented GitLab CI for building and deploying to Open Data Portal SH.
### Fixed
- Updated the license link to point to the correct location.
## [0.0.1] - 2022-04-27
### Added
- Initial codebase for the project.
File moved
......@@ -4,36 +4,59 @@
# ODSH Website - Documentation
Hugo website for the [Open Data Portal Schleswig-Holstein](opendata.schleswig-holstein.de/).
Hugo website for the [Open Data Portal Schleswig-Holstein](https://opendata.schleswig-holstein.de/).
</div>
<!-- markdownlint-restore -->
**This is work-in-progress!**
*More content will follow soon.*
Hugo is a popular static website generator designed to create static HTML websites. It simplifies the process of building websites by generating all the necessary files and assets upfront, which can then be deployed to a web server.
## Table of Contents
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
## Getting Started
> **Hugo** is an open source static site generator. Static site generators build a web page once, at the moment you're creating new content or editing it.
Follow these instructions to get started with the ODSH Website.
### Prerequisites
Before you start you need to make sure that you have Hugo installed.
Before you begin, ensure that you have Hugo installed on your system.
- [Hugo](https://gohugo.io/getting-started/installing/)
### Build and run the application
You can run the application with
To run the application, execute the following command:
```console
hugo server --config config-stage.yml
```
This should start the default webserver at [http://localhost:1313/](http://localhost:1313/).
This command will start the default web server, and you can access it at [http://localhost:1313/](http://localhost:1313/).
*Please note, that you have to specify a config file (`config-stage.yml` or `config-prod.yml`).*
*Note: Remember to specify a configuration file (config-stage.yml or config-prod.yml).*
## Contributing
To contribute to this repository, create a branch or fork this repository, make
your changes and create a merge request.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see
the [tags on this repository](https://code.schleswig-holstein.de/opendata/odsh-website/-/tags).
## Authors
See also the list of [contributors](https://code.schleswig-holstein.de/opendata/odsh-website/-/graphs/main)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE)
file for details.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment