From 2d1db18b477b4549df0949a5bcfe770b6be793a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Mileti=C4=87?= Date: Tue, 26 Sep 2023 07:37:25 +0200 Subject: [PATCH 1/4] Introduced requirements.txt file for pip --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..a3385cab --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs-material +cairosvg From 2ef44733d25d0d1826b1cae5a4aa4c105d14b46e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Mileti=C4=87?= Date: Tue, 26 Sep 2023 07:39:25 +0200 Subject: [PATCH 2/4] Enabled the built-in social plugin Adds a good looking and automatically generated social card to each page of the documentation (for sharing on FB, X, Linkedin, etc.). --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index cba093cb..b9f3a227 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,9 @@ markdown_extensions: - pymdownx.details - pymdownx.superfences +plugins: + - social + theme: name: 'material' logo: 'assets/memgraph-logo.svg' From 30a0691c89dff1dca217001b422d16796d929bfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Mileti=C4=87?= Date: Tue, 26 Sep 2023 09:26:45 +0200 Subject: [PATCH 3/4] Updated README to include cairosvg installation --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index df6a09fb..a406008d 100644 --- a/README.md +++ b/README.md @@ -118,6 +118,7 @@ Other parts of the documentation are written and located at docs directory. To t pip3 install mkdocs pip3 install mkdocs-material pip3 install pymdown-extensions +pip3 install cairosvg mkdocs serve ``` From 4b324ba0443f2f41c119a7bda1fc645726bb6dbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Mileti=C4=87?= Date: Sun, 1 Oct 2023 16:05:57 +0200 Subject: [PATCH 4/4] Disabled social plugin for local builds --- mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index b9f3a227..a764b474 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,7 +7,8 @@ markdown_extensions: - pymdownx.superfences plugins: - - social + - social: + enabled: !ENV [CI, false] theme: name: 'material'