feat(docs): better social cards

stac-utils · Sep 23, 2024 · 9beed7d · 9beed7d
1 parent afcfc98
commit 9beed7d
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 1 deletion.
diff --git a/docs/cli/index.md b/docs/cli/index.md
@@ -1,3 +1,7 @@
+---
+description: The stac-rs command-line interface (CLI), stacrs
+---
+
 # Command-line interface (CLI)
 
 The **stac-rs** command-line interface can be installed two ways.

diff --git a/docs/python/api/index.md b/docs/python/api/index.md
@@ -1,3 +1,7 @@
+---
+description: The stacrs Python API
+---
+
 # Python API
 
 API documentation for the **stacrs** Python package.

diff --git a/docs/python/api/migrate.md b/docs/python/api/migrate.md
@@ -1,3 +1,7 @@
+---
+description: Migrate STAC to another version
+---
+
 # Migration
 
 ::: stacrs.migrate

diff --git a/docs/python/api/pystac.md b/docs/python/api/pystac.md
@@ -1,3 +1,7 @@
+---
+description: Interface with pystac
+---
+
 # pystac
 
 These functions are only available if [pystac](https://pystac.readthedocs.io/) is available on your system.

diff --git a/docs/python/api/read.md b/docs/python/api/read.md
@@ -1,3 +1,7 @@
+---
+description: Read STAC from the local filesystem or blob storage
+---
+
 # Read
 
 ::: stacrs.read
diff --git a/docs/python/api/search.md b/docs/python/api/search.md
@@ -1,3 +1,7 @@
+---
+description: Search a STAC API
+---
+
 # Search
 
 ::: stacrs.search

diff --git a/docs/python/api/validate.md b/docs/python/api/validate.md
@@ -1,3 +1,7 @@
+---
+description: Validate STAC with json-schema
+---
+
 # Validate
 
 ::: stacrs.validate

diff --git a/docs/python/api/write.md b/docs/python/api/write.md
@@ -1,3 +1,7 @@
+---
+description: Write STAC to the filesystem or to blob storage
+---
+
 # Write
 
 ::: stacrs.write
diff --git a/docs/python/index.md b/docs/python/index.md
@@ -1,3 +1,7 @@
+---
+description: The stac-rs Python package, stacrs
+---
+
 # stacrs
 
 A Python package for working with [STAC](https://stacspec.org) designed to compliment existing packages such as [pystac](https://pystac.readthedocs.io) and [pystac-client](https://pystac-client.readthedocs.io).

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,5 @@
 site_name: stac-rs
+site_description: Command Line Interface (CLI), Rust crates, and other libraries for the SpatioTemporal Asset Catalog (STAC) specification.
 site_url: https://stac-utils.github.io/stac-rs
 repo_url: https://github.com/stac-utils/stac-rs
 theme:
@@ -30,7 +31,10 @@ nav:
       - cli/index.md
 plugins:
   - search
-  - social
+  - social:
+      cards_layout_options:
+        color: rgb(26, 78, 99)
+        background_color: rgb(228, 246, 251)
   - mkdocstrings:
       enable_inventory: true
       handlers: