From 036560f2babb10bf6eaf7f0aa6253c044b76677b Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 17 Sep 2025 14:51:07 +0200 Subject: [PATCH 1/3] Update settings & homepage --- README.md | 15 +++++++++++++-- docs/index.md | 21 +++++++++------------ mkdocs.yml | 16 ++++++++++++++-- 3 files changed, 36 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c3d8a25..8c25aa1 100644 --- a/README.md +++ b/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,13 @@ 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: + +``` +npm install -g markdownlint-cli +npx markdownlint-cli . +``` diff --git a/docs/index.md b/docs/index.md index 9824763..bfd3467 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,11 @@ -# 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) diff --git a/mkdocs.yml b/mkdocs.yml index b351b08..1f6a16d 100644 --- a/mkdocs.yml +++ b/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: -- 2.49.1 From 9d65342b7da05c8aba0b5e9c115e2b62e986775a Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 17 Sep 2025 15:46:08 +0200 Subject: [PATCH 2/3] Configure markdownlint --- .markdownlint.yaml | 9 +++++++++ docs/index.md | 1 + 2 files changed, 10 insertions(+) create mode 100644 .markdownlint.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..a3879fe --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,9 @@ +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 diff --git a/docs/index.md b/docs/index.md index bfd3467..2103952 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,4 @@ +--- title: Home --- # PSI Data Catalog Documentation -- 2.49.1 From 3c108c7fff83bd066b887bc3a4dc4325b7498d02 Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Wed, 17 Sep 2025 15:54:14 +0200 Subject: [PATCH 3/3] Fix lint error --- .markdownlint.yaml | 1 + README.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index a3879fe..b9a88ff 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -7,3 +7,4 @@ heading-style: style: atx no-missing-space-atx: true single-title: false +fenced-code-language: true \ No newline at end of file diff --git a/README.md b/README.md index 8c25aa1..b520379 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,10 @@ 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: +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 . ``` -- 2.49.1