docs: add logo and favicon to docs.rs page

ratatui · Sep 8, 2023 · 7f5935c · 7f5935c
1 parent 0c68ebe
commit 7f5935c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/assets/favicon.ico b/assets/favicon.ico
diff --git a/assets/logo.png b/assets/logo.png
diff --git a/src/lib.rs b/src/lib.rs
@@ -182,8 +182,13 @@
 //! [Termion crate]: https://crates.io/crates/termion
 //! [Termwiz crate]: https://crates.io/crates/termwiz
 //! [Time crate]: https://crates.io/crates/time
+
 // show the feature flags in the generated documentation
 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/ratatui-org/ratatui/main/assets/logo.png",
+    html_favicon_url = "https://raw.githubusercontent.com/ratatui-org/ratatui/main/assets/favicon.ico"
+)]
 
 pub mod backend;
 pub mod buffer;