.markdownlint.yaml

@@ -0,0 +1,10 @@
+default: true
+line-length:
+  line_length: 88
+  tables: false
+no-trailing-punctuation: true
+heading-style:
+  style: atx
+no-missing-space-atx: true
+single-title: false
+fenced-code-language: true

README.md

@@ -1,6 +1,7 @@
-# gitea-pages
+# PSI Data Catalog Documentation
 
-PSI Data Catalog Documentation
+This repository contains the source code for the [PSI Data Catalog
+Documentation](https://data-catalog-services.pages.psi.ch/)
 
 ## Contributing
 
@@ -9,3 +10,14 @@ docker compose up -d
 ```
 
 to spin up a local environment. Preview available on `localhost:8000`.
+
+## Style Guide
+
+Pull requests enforce [markdownlint](https://github.com/DavidAnson/markdownlint) checks.
+It is recommended to lint files before committing, either using your editor or by
+running manually:
+
+```console
+npm install -g markdownlint-cli
+npx markdownlint-cli .
+```

docs/index.md

@@ -1,14 +1,12 @@
-# Hello World! 👋
+---
+title: Home
+---
+# PSI Data Catalog Documentation
 
-*Knock knock.*
-"Who's there?"
-"World."
-"World who?"
-"World you like to say hello back?"
+The PSI Data Catalog is the preferred way to archive and publish research data from the
+[Paul Scherrer Institute](https://www.psi.ch). Archive, publish, and share your open
+research data following [FAIR data
+principles](https://force11.org/info/the-fair-data-principles/).
 
-## Fun Fact
-
-This page has achieved more in 10 seconds than I have all morning.
-
-*PS: If you're reading this, you've successfully discovered the most important
-page on the internet. Congratulations! 🎉*
+- Browse the Data Catalog at [discovery.psi.ch](https://discovery.psi.ch)
+- See published datasets at [doi.psi.ch](https://doi.psi.ch)

mkdocs.yml

@@ -3,15 +3,27 @@ site_name: PSI Data Catalog Documentation
 site_url: https://data-catalog-services.pages.psi.ch
 
 # Repository
-repo_name: data-catalog-services/gitea-pages
-repo_url: https://gitea.psi.ch/data-catalog-services/gitea-pages
+#repo_name: data-catalog-services/gitea-pages
+#repo_url: https://gitea.psi.ch/data-catalog-services/gitea-pages
 
 # Copyright
 copyright: Copyright © 2025 Paul Scherrer Institute
 
+markdown_extensions:
+- admonition
+- toc:
+    permalink: true
+
 # Configuration
 theme:
   name: material
+  features:
+    - header.autohide
+    - navigation.instant
+    - navigation.tracking
+    #- navigation.tabs
+    - toc.follow
+    # - toc.integrate
   palette:
     - media: "(prefers-color-scheme)"
       toggle: