From da07c8c6e808054c3fdfcb973b34708ea662af55 Mon Sep 17 00:00:00 2001 From: Luca Palmieri <20745048+LukeMathWalker@users.noreply.github.com> Date: Tue, 2 Jan 2024 17:14:52 +0000 Subject: [PATCH] Social (#142) Fix social preview for docs. --- docs/Dockerfile | 1 + docs/assets/logo.ico | Bin 0 -> 4286 bytes docs/overview/index.md | 2 +- mkdocs.yml | 2 ++ 4 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 docs/assets/logo.ico diff --git a/docs/Dockerfile b/docs/Dockerfile index 9489f5bd1..b45908612 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,3 +1,4 @@ FROM squidfunk/mkdocs-material:9 RUN pip install mkdocs-awesome-pages-plugin RUN pip install pygments_ansi_color +RUN pip install "mkdocs-material[imaging]" diff --git a/docs/assets/logo.ico b/docs/assets/logo.ico new file mode 100644 index 0000000000000000000000000000000000000000..7da7089df7c18f0547503b7e873a76f65f540669 GIT binary patch literal 4286 zcmcgwH%n|=6h7}Cyz14re5Hk@g%*~Ap%4U7(MCmdOrWT!7%}IZFz1|ej-a4|76wFA z6a(hG-h7LKG+6f~2&nbRp85@1YwUP`f2YsSPnPlg{LG?1 zK0fI6^_9PYSKD)beom*Sr;K}ec+l~I&Qf@Me58bg1fBgkIXSevyi8eHS+umY#NxcX zyl8cGmA@Aj7RcYlqk+uIv0E-sRr zn;ZH1`m(Hpg9CDLaiQYkVqTApjgg<9A6;Br@EShb*w|22RTZxhM@!)T{+`0a!zna0 zlv-O`nHBoW%F6gVF)@)QCMGC4I-2t_H#bL~o}RR`v%~o9?QL>)cBZtnG+tZcJ2Pm1 z+S=NvrKN==_cJpybbNfw=+V(pLM^PXuXB8_udfL)A0HoQJaU8>O;1k~e6bevYajBS zo}LJG0#Mf>Z~VXa6TgKYIgq7ol~i3_&Gi->9LzC3Iy%zDKzPiNZ;VE4FE1}=-90@${MKkRqzTbbetteh zMn>}E>gq}n5fL;$KhGkqwLx^}=H_w_Ha9nuqoX7B_VyC&!5h6^Q&U479UWY&DJdyD z12Qr)*aned%tu2wu^saxGc%KC2xOx7FlW%yzzq!z5psb(fqk%Rb90mI?d>@>kZq|A zQm^PI^nPDoAIn1@6&4oK?CdPn*47eo0smnO{70WcKj`Y~>nS-onb)vE{K2;=5L)QK z>_be^_iJlwtONNiEiL`6e%J^7u*cTcmU{v^#V=F(g%0)?6ckW@e?PN`UFdh5GYt(5 zgx-_EC!$_;RnE+IuM$bl@-E#kB^UMS$lhXgn2$WImxyJ1qIQ-zyQld z9pGtfY~*wC<>iHAj(Jg3R7Bq1-aL~qt4)FEM_fHTJh+#@BXN;8&I80JHa3<;;v7OA z08LFz6cQ4`^^aWm`1p{MlM~wryg7LQ9RTxAJ>S8LN9=^I^z?N08?}$K4mBh96P!EQ z+1b30ya0rk7r*(DSRr@&`}<5KzGH!Jne*s>%wRh^JI)XA!oRz_%W*;v$-O`=2egJj zVuZSae1Pn!>BScZ2L}oZ3u6?{Akkk}SI6;?JAlxuWf=QLo&y5|>F(~1$@FcP_1W1O z_XCJT$K~ZE_YdZGdwV27W{iW-RIepw7LT1$N*8UUZ;;aBspL3NiT!hz+>o zNgqRwS{L-87K9eK)YMe&1KiDUUH}Bo3k!b4ADl1fd)z+^0p#N@jGlzwm|b#j6d8v2 z%-IwE!^1;94=@uk>tIuNcQ@5&dmr-vcXZ5t#9VzZGDn9g8u*9U0&Z__2{REsV!mN6 zqt0;G$9XM(gNWUxWSfgu=N&wl$LM{;VQ_Ge&n4`G?x*<%zc~Q;=yQEN@LA$yjvQ-g VpdUK_v|elN7JmKz5BSsT{{XN4r3C;0 literal 0 HcmV?d00001 diff --git a/docs/overview/index.md b/docs/overview/index.md index f62bf9d8e..a869ec941 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,7 +1,7 @@ # Welcome Hey there! -This is the documentation for **Pavex**, a framework for building APIs in **Rust**. +This is the documentation for **Pavex**, a framework for building robust APIs in **Rust**. ## Getting Started diff --git a/mkdocs.yml b/mkdocs.yml index 39f2d7f6d..1820e9b5d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,6 @@ site_name: Pavex site_url: "https://pavex.dev/" +site_description: "The documentation for Pavex, a framework for building robust APIs in Rust." repo_url: "https://github.com/LukeMathWalker/pavex" repo_name: "LukeMathWalker/pavex" edit_uri: "edit/main/docs/" @@ -31,6 +32,7 @@ markdown_extensions: theme: name: material logo: assets/inverted_logo.png + favicon: assets/logo.ico icon: repo: fontawesome/brands/github edit: material/pencil