Social (#142)

Fix social preview for docs.
LukeMathWalker · Jan 2, 2024 · da07c8c · da07c8c
1 parent 30626f0
commit da07c8c
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 1 deletion.
diff --git 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
diff --git 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
@@ -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