diff --git a/.idea/runConfigurations/Documentation_website.xml b/.idea/runConfigurations/Documentation_website.xml new file mode 100644 index 0000000..1c2fb07 --- /dev/null +++ b/.idea/runConfigurations/Documentation_website.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + \ No newline at end of file -- 2.51.2 From e1eea66eeae2979ea9395f6e7fe9b23cc38b314f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 19:59:24 +0200 Subject: [PATCH 2/8] docs(website): Fix the edition link --- docs/website/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 787b9ef..a8c5edb 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -37,4 +37,4 @@ theme: edit: material/pencil view: material/eye -edit_uri: edit/main/docs/website +edit_uri: edit/main/docs/website/docs -- 2.51.2 From 1aa7b3aa2f7064d063794c12045aeb40f2bece14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 20:21:19 +0200 Subject: [PATCH 3/8] docs(website): Add OpenSavvy logo --- docs/website/docs/assets/logo.svg | 127 ++++++++++++++++++++++++++++++ docs/website/mkdocs.yml | 2 + 2 files changed, 129 insertions(+) create mode 100644 docs/website/docs/assets/logo.svg diff --git a/docs/website/docs/assets/logo.svg b/docs/website/docs/assets/logo.svg new file mode 100644 index 0000000..3c87a67 --- /dev/null +++ b/docs/website/docs/assets/logo.svg @@ -0,0 +1,127 @@ + + + + + + + + + + + + + + + + + + + + + + + + + O + + + S + + + + + + + + diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index a8c5edb..da9930a 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -36,5 +36,7 @@ theme: icon: edit: material/pencil view: material/eye + logo: assets/logo.svg + favicon: assets/logo.svg edit_uri: edit/main/docs/website/docs -- 2.51.2 From e39f9a578bf8ffef3137f794109be7190d0faee5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 20:21:39 +0200 Subject: [PATCH 4/8] docs(website): Enable line selection for code samples --- docs/website/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index da9930a..33ee70c 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -11,7 +11,7 @@ theme: - content.action.view - content.code.annotate - content.code.copy - # - content.code.select + - content.code.select # - content.footnote.tooltips # - content.tabs.link - content.tooltips -- 2.51.2 From d812bb787d527f75b2b8463a637144d49870a1ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 20:26:47 +0200 Subject: [PATCH 5/8] docs(website): Let the user select between light and dark themes --- docs/website/mkdocs.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 33ee70c..67b89ad 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -38,5 +38,20 @@ theme: view: material/eye logo: assets/logo.svg favicon: assets/logo.svg + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: "System theme (click to switch to light)" + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: "Light theme (click to switch to dark)" + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: "Dark theme (click to switch to system)" edit_uri: edit/main/docs/website/docs -- 2.51.2 From 47d143b15514b7b95d7e1769b9e2c7df80210fbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 20:35:18 +0200 Subject: [PATCH 6/8] docs(website): Use the OpenSavvy color palette (approximately) --- docs/website/mkdocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 67b89ad..77bcc3d 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -45,11 +45,15 @@ theme: name: "System theme (click to switch to light)" - media: "(prefers-color-scheme: light)" scheme: default + primary: deep purple + accent: cyan toggle: icon: material/brightness-7 name: "Light theme (click to switch to dark)" - media: "(prefers-color-scheme: dark)" scheme: slate + primary: deep purple + accent: cyan toggle: icon: material/brightness-4 name: "Dark theme (click to switch to system)" -- 2.51.2 From bed23ddca0ec5bf8794439cf511bc21cfa695817 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 20:37:27 +0200 Subject: [PATCH 7/8] docs(website): Create the main tabs --- docs/website/mkdocs.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 77bcc3d..98813dd 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -59,3 +59,12 @@ theme: name: "Dark theme (click to switch to system)" edit_uri: edit/main/docs/website/docs + +nav: + - Home: index.md + + - Getting started: [] + + - Module1: [] + + - Module2: [] -- 2.51.2 From 2c62272aae410cc693c0cc4f931a239673dace8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Thu, 25 Apr 2024 21:48:35 +0200 Subject: [PATCH 8/8] docs(website): Custom home page --- docs/website/docs/index.md | 6 +++- docs/website/mkdocs.yml | 1 + docs/website/overrides/home.html | 61 ++++++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 docs/website/overrides/home.html diff --git a/docs/website/docs/index.md b/docs/website/docs/index.md index ceea72a..4f5ca0b 100644 --- a/docs/website/docs/index.md +++ b/docs/website/docs/index.md @@ -1,3 +1,7 @@ -# Home +--- +template: home.html +--- + +# Welcome! The OpenSavvy Playground is a project template with pre-configured CI/CD, documentation generator, etc. diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 98813dd..112d0f9 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -5,6 +5,7 @@ site_description: > theme: name: material + custom_dir: overrides features: - announce.dismiss - content.action.edit diff --git a/docs/website/overrides/home.html b/docs/website/overrides/home.html new file mode 100644 index 0000000..29eaa5e --- /dev/null +++ b/docs/website/overrides/home.html @@ -0,0 +1,61 @@ +{% extends "main.html" %} +{% block tabs %} +{{ super() }} + + +
+
+
+
+

{{ config.site_name }}

+ +

{{ config.site_description }}

+ +
+ + +
+ + + Quick start + + + Visit repository + +
+
+
+
+{% endblock %} + +{% block content %} +
+ {{ super() }} +
+{% endblock %}