add gitea workflows
All checks were successful
Build and Deploy Documentation / build-and-deploy (push) Successful in 12s

This commit is contained in:
2025-04-24 14:53:25 +02:00
parent 5a1f4e7bcf
commit 3a970492c7
8 changed files with 66 additions and 70 deletions

View File

@ -1,8 +1,7 @@
# HPCE Documentation
This site documents HCPE services at Paul Scherrer Institute, particularly the *Merlin 6* cluster.
Live pages are available at https://lsm-hpce.gitpages.psi.ch.
This site contains internal documentation of HCPE services at Paul Scherrer Institute, particularly the *Merlin 6* and *Merlin 7* clusters.
Live pages are available at <https://hpce.pages.psi.ch>.
## Installation
@ -45,7 +44,8 @@ by Tom Johnson.
- Documentation is organized within the `pages` directory
- Add the following frontmatter to each (Merlin6) page:
```
```md
---
title: Introduction
sidebar: merlin6_sidebar
@ -53,12 +53,19 @@ by Tom Johnson.
keywords: key1, key2
---
```
- Sidebars are specified in data files, e.g. `_data/sidebars/merlin6_sidebar.yml`.
- The top menu is controlled by `_data/topnav.yml`
- News can be addin in `_posts`. Filenames must include the date.
- Lots of features still need to be configured (e.g. pdf output, tags, etc)
- The search bar uses finds substring of the title, tags, keywords, and summary frontmatter.
## Deployment
We use the Gitea workflow (see `.gitea/workflow/deploy-pages.yml` for details). The
pages are automatically re-generated on each push to `master` branch. The resulting website
is stored under the `gitea-pages` branch, and is automatically exposed.
## License
Theme content is licensed under the MIT license.