From 2e17d76e0e1d2f354e23ec8310fef8c97d5f2a05 Mon Sep 17 00:00:00 2001 From: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Date: Wed, 4 Jun 2025 21:02:00 +0200 Subject: [PATCH] renamed 'home.md' to 'index.md' and updated readme --- README.md | 14 +++++++++++++- docs/faq.md | 6 +----- docs/{home.md => index.md} | 0 mkdocs.yaml | 2 +- requirements.txt | 2 +- 5 files changed, 16 insertions(+), 8 deletions(-) rename docs/{home.md => index.md} (100%) diff --git a/README.md b/README.md index 2fe12ef17e..8eb2ff34e0 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# RSE@PSI Website \ No newline at end of file +# RSE@PSI Website + +## Build Instructions + +1. Install the required dependencies: + ```bash + pip install -r requirements.txt + ``` + +2. [Build the website](https://www.mkdocs.org/getting-started/): + ```bash + mkdocs serve + ``` \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 8814d2c1ab..32cce9075d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1 @@ -# FAQ - -
- -
\ No newline at end of file +# FAQ \ No newline at end of file diff --git a/docs/home.md b/docs/index.md similarity index 100% rename from docs/home.md rename to docs/index.md diff --git a/mkdocs.yaml b/mkdocs.yaml index 2c6f2fefd6..9fa5b0673d 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -2,7 +2,7 @@ site_name: RSE@PSI copyright: © Paul Scherrer Institute (PSI) | Content under CC0 License nav: - - Home: 'home.md' + - Home: 'index.md' - About: 'about.md' - FAQ: 'faq.md' - Blog: 'blog/index.md' diff --git a/requirements.txt b/requirements.txt index d358679249..ffba163e3f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ mkdocs==1.6.1 mkdocs-autorefs==1.4.2 mkdocs-material==9.6.14 pymdown-extensions==10.15 -mkdocs-include-markdown-plugin==7.1.5 +mkdocs-include-markdown-plugin==7.1.5 \ No newline at end of file