docs: add logo to the rustdoc (#198)

cot-rs · Feb 24, 2025 · 42eba08 · 42eba08
1 parent 3352ce5
commit 42eba08
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-<h1>Cot</h1>
+<h1><img src="https://raw.githubusercontent.com/cot-rs/media/6585c518/logo/logo-text.svg" alt="Cot" width="300"></h1>
 
 [![Rust Build Status](https://github.com/cot-rs/cot/workflows/Rust%20CI/badge.svg)](https://github.com/cot-rs/cot/actions/workflows/rust.yml)
 [![crates.io](https://img.shields.io/crates/v/cot.svg)](https://crates.io/crates/cot)

diff --git a/cot/src/lib.rs b/cot/src/lib.rs
@@ -46,6 +46,10 @@
     feature(doc_cfg, doc_auto_cfg, rustdoc_missing_doc_code_examples)
 )]
 #![cfg_attr(docsrs, warn(rustdoc::missing_doc_code_examples))]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/cot-rs/media/6585c518/logo/logo.svg",
+    html_favicon_url = "https://raw.githubusercontent.com/cot-rs/media/6585c518/logo/favicon.svg"
+)]
 
 extern crate self as cot;