docs(lib): add logo and favicon to docs.rs page

orhun · Oct 28, 2023 · 32b1fe1 · 32b1fe1
1 parent 91c0cda
commit 32b1fe1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/git-cliff-core/src/lib.rs b/git-cliff-core/src/lib.rs
@@ -1,4 +1,4 @@
-//! A highly customizable changelog generator
+//! A highly customizable changelog generator ⛰️
 //!
 //! ## Features
 //!
@@ -8,6 +8,10 @@
 //!   You can turn this off if you already have the commits to put in the
 //!   changelog and you don't need `git-cliff` to parse them.
 #![warn(missing_docs, clippy::unwrap_used)]
+#![doc(
+	html_logo_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff.png",
+	html_favicon_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/favicon/favicon.ico"
+)]
 
 /// Changelog generator.
 pub mod changelog;

diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -1,3 +1,9 @@
+//! A highly customizable changelog generator ⛰️
+#![doc(
+	html_logo_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff.png",
+	html_favicon_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/favicon/favicon.ico"
+)]
+
 /// Command-line argument parser.
 pub mod args;