diff --git a/README.md b/README.md
index 4b705d4..d1384fe 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,35 @@
-# Website
+# mpusp.github.io
+[](https://github.com/MPUSP/mpusp.github.io/actions/workflows/deploy.yml)
+[](https://github.com/MPUSP/mpusp.github.io/actions/workflows/deploy.yml)
+
+A homepage for the bioionformatic platform of the Max-Planck-Unit for the Science of Pathogens ([MPUSP](mpusp.mpg.de)).
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+All data to render the less-static parts of the website (repo and user stats) are retrieved from Github using API requests.
+The website is automatically updated and built once per week, and on pull requests to the `main` branch.
+
+### Structure
+
+- The website is build using the Github action `.github/workflows/deploy.yml`.
+- The website building is tested for each PR to main with `.github/workflows/test-deploy.yml`
+- The Github action will retrieve public data from the Github API using two scripts
+ - `src/scripts/generate_page.py`: collects all relevant data and stores it in `static/data/*.json`
+ - `src/scripts/generate_workflow_md.py`: collects relevant workflow data and renders an info page in markdown format, exported to `docs/workflows/all_workflows/*.md`
+- static page data is located in the `docs/` dir, where also new `.md` docs can be added
+- all custom website elements and styles (cards, bar charts, etc) are located in `src/components`
+- global color and style definitions are located in `src/css/custom.css`
+- global header, footer, and metadata definition is located in `docusaurus.config.js`
+
+### Dependencies
+
+To develop the page locally, create a conda environment with the required packages:
+
+```bash
+conda create -n docusaurus -c conda-forge python pygithub jinja2 nodejs
+conda activate docusaurus
+```
-### Installation
+To create a test page, run:
```bash
npm create-docusaurus@latest docusaurus-test classic
@@ -10,13 +37,13 @@ npm create-docusaurus@latest docusaurus-test classic
### Local Development
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
```bash
npm start
```
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
+To build the website locally, run:
```bash
npm run build
diff --git a/docusaurus.config.js b/docusaurus.config.js
index df49835..6765b49 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -80,6 +80,11 @@ const config = {
label: "Workflows",
},
{ to: "/blog", label: "News", position: "left" },
+ {
+ href: "https://mpusp.mpg.de",
+ label: "MPUSP",
+ position: "right",
+ },
{
href: "https://github.com/MPUSP",
label: "MPUSP GitHub",
@@ -138,7 +143,7 @@ const config = {
darkTheme: prismThemes.dracula,
},
colorMode: {
- defaultMode: "dark",
+ defaultMode: "light",
disableSwitch: false,
respectPrefersColorScheme: false,
},
diff --git a/src/components/About/index.jsx b/src/components/About/index.jsx
index f91643f..0abcb1d 100644
--- a/src/components/About/index.jsx
+++ b/src/components/About/index.jsx
@@ -47,16 +47,15 @@ export default function Stats() {
Our Github Projects
- More than 30 open-source{" "}
- MPUSP repositories{" "}
- are available on Github, representing a diverse range of projects.
+ We work on a diverse range of projects and aim to make as many as possible{" "}
+ publicly available on Github{" "}.