rdm.sfb1451.de/content/about/contributing.md
Michał Szczepanik 902cba0a53
All checks were successful
Deploy on webserver / Build site with hugo and deploy on success (push) Successful in 42s
Update copyright year & link in contributing
2026-11-13 19:12:22 +01:00

31 lines
890 B
Markdown

+++
title = "Contributing"
menu = "shortcuts"
+++
This documentation website is built with the [hugo](https://gohugo.io/) static website generator.
Content of the pages is written in [markdown](https://daringfireball.net/projects/markdown/).
The repository is hosted on [Cerebra](https://cerebra.fz-juelich.de/sfb1451-inf/rdm.sfb1451.de) (Forgejo instance).
Patches are welcome.
## Setup
After cloning the repository, you need to obtain the website theme.
The theme has been added as a git submodule.
```
git submodule update --init
```
To build the site locally and output a URL to open in a browser to test it, run:
```
hugo server
```
## Content
The page sources are organized into folders under the `content\` directory, corresponding to "chapters".
See [Hugo relearn theme](https://mcshelby.github.io/hugo-theme-relearn/index.html) for tips on available formatting features.