diff --git a/examples/query_segments_demo/src/main.rs b/examples/query_segments_demo/src/main.rs index d9f5f83ef..aafcc0f43 100644 --- a/examples/query_segments_demo/src/main.rs +++ b/examples/query_segments_demo/src/main.rs @@ -35,7 +35,7 @@ impl Display for BlogQuerySegments { } } -/// The query segment is anything that implements https://docs.rs/dioxus-router/latest/dioxus_router/routable/trait.FromQuery.html. You can implement that trait for a struct if you want to parse multiple query parameters. +/// The query segment is anything that implements . You can implement that trait for a struct if you want to parse multiple query parameters. impl FromQuery for BlogQuerySegments { fn from_query(query: &str) -> Self { let mut name = None; diff --git a/packages/autofmt/src/lib.rs b/packages/autofmt/src/lib.rs index 8ec33f0f0..64a342885 100644 --- a/packages/autofmt/src/lib.rs +++ b/packages/autofmt/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + use std::fmt::{Display, Write}; use crate::writer::*; diff --git a/packages/check/README.md b/packages/check/README.md index 0bb6ce0a4..6375a8316 100644 --- a/packages/check/README.md +++ b/packages/check/README.md @@ -6,7 +6,7 @@ [![Discord chat][discord-badge]][discord-url] [crates-badge]: https://img.shields.io/crates/v/dioxus-autofmt.svg -[crates-url]: https://crates.io/crates/dioxus-autofmt +[crates-url]: https://crates.io/crates/dioxus-check [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg [mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE [actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg @@ -16,7 +16,7 @@ [Website](https://dioxuslabs.com) | [Guides](https://dioxuslabs.com/learn/0.4/) | -[API Docs](https://docs.rs/dioxus-autofmt/latest/dioxus_autofmt) | +[API Docs](https://docs.rs/dioxus-check) | [Chat](https://discord.gg/XgGxMSkvUM) ## Overview diff --git a/packages/check/src/lib.rs b/packages/check/src/lib.rs index 3870fb610..43a164514 100644 --- a/packages/check/src/lib.rs +++ b/packages/check/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + mod check; mod issues; mod metadata; diff --git a/packages/cli/src/lib.rs b/packages/cli/src/lib.rs index c067ab148..b27cf55a9 100644 --- a/packages/cli/src/lib.rs +++ b/packages/cli/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + pub const DIOXUS_CLI_VERSION: &str = "0.4.1"; pub mod builder; diff --git a/packages/core-macro/src/lib.rs b/packages/core-macro/src/lib.rs index d91c72e39..477c05d76 100644 --- a/packages/core-macro/src/lib.rs +++ b/packages/core-macro/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + use proc_macro::TokenStream; use quote::ToTokens; use rsx::RenderCallBody; diff --git a/packages/core/src/lib.rs b/packages/core/src/lib.rs index 029e884db..ee557af2d 100644 --- a/packages/core/src/lib.rs +++ b/packages/core/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![warn(missing_docs)] mod any_props; diff --git a/packages/dioxus-tui/src/lib.rs b/packages/dioxus-tui/src/lib.rs index fd5b63501..ca0f0a07d 100644 --- a/packages/dioxus-tui/src/lib.rs +++ b/packages/dioxus-tui/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + mod element; use std::{ diff --git a/packages/dioxus/src/lib.rs b/packages/dioxus/src/lib.rs index bc2cd76e6..6256e96d7 100644 --- a/packages/dioxus/src/lib.rs +++ b/packages/dioxus/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + pub use dioxus_core as core; #[cfg(feature = "hooks")] diff --git a/packages/fermi/src/lib.rs b/packages/fermi/src/lib.rs index 4943e38a3..52bf4cd09 100644 --- a/packages/fermi/src/lib.rs +++ b/packages/fermi/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] pub mod prelude { pub use crate::*; diff --git a/packages/generational-box/README.md b/packages/generational-box/README.md index 5ab7926ba..63c539e08 100644 --- a/packages/generational-box/README.md +++ b/packages/generational-box/README.md @@ -31,4 +31,4 @@ let store = Store::default(); ## How it works -Internally \ No newline at end of file +Internally \ No newline at end of file diff --git a/packages/hooks/src/lib.rs b/packages/hooks/src/lib.rs index ec2889e55..a5b92a036 100644 --- a/packages/hooks/src/lib.rs +++ b/packages/hooks/src/lib.rs @@ -1,3 +1,6 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![cfg_attr(feature = "nightly-features", feature(debug_refcell))] #[macro_export] diff --git a/packages/html/src/lib.rs b/packages/html/src/lib.rs index 2fc1baeac..6dd7c42bd 100644 --- a/packages/html/src/lib.rs +++ b/packages/html/src/lib.rs @@ -1,3 +1,6 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![allow(non_snake_case)] //! # Dioxus Namespace for HTML diff --git a/packages/interpreter/src/lib.rs b/packages/interpreter/src/lib.rs index 47093c29c..c540b0d7d 100644 --- a/packages/interpreter/src/lib.rs +++ b/packages/interpreter/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + pub static INTERPRETER_JS: &str = include_str!("./interpreter.js"); pub static COMMON_JS: &str = include_str!("./common.js"); diff --git a/packages/liveview/src/lib.rs b/packages/liveview/src/lib.rs index a7370e91c..6a2768fd5 100644 --- a/packages/liveview/src/lib.rs +++ b/packages/liveview/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + pub mod adapters { #[cfg(feature = "warp")] pub mod warp_adapter; diff --git a/packages/mobile/src/lib.rs b/packages/mobile/src/lib.rs index 36940cff7..5cc2c6ae9 100644 --- a/packages/mobile/src/lib.rs +++ b/packages/mobile/src/lib.rs @@ -1,3 +1,5 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] pub use dioxus_desktop::*; diff --git a/packages/native-core-macro/src/lib.rs b/packages/native-core-macro/src/lib.rs index d122838bd..fdaa12cf5 100644 --- a/packages/native-core-macro/src/lib.rs +++ b/packages/native-core-macro/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + extern crate proc_macro; use std::collections::HashSet; diff --git a/packages/native-core/src/lib.rs b/packages/native-core/src/lib.rs index c5ad38341..dd36990a7 100644 --- a/packages/native-core/src/lib.rs +++ b/packages/native-core/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![warn(missing_docs)] use std::any::Any; diff --git a/packages/rink/src/lib.rs b/packages/rink/src/lib.rs index 81ab45a85..2eba1b98a 100644 --- a/packages/rink/src/lib.rs +++ b/packages/rink/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + use crate::focus::Focus; use anyhow::Result; use crossterm::{ diff --git a/packages/router-macro/src/lib.rs b/packages/router-macro/src/lib.rs index b1ff7b0fe..8844c6a35 100644 --- a/packages/router-macro/src/lib.rs +++ b/packages/router-macro/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + extern crate proc_macro; use layout::Layout; diff --git a/packages/router/src/lib.rs b/packages/router/src/lib.rs index a92394513..e871dc6c9 100644 --- a/packages/router/src/lib.rs +++ b/packages/router/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] // cannot use forbid, because props derive macro generates #[allow(missing_docs)] #![deny(missing_docs)] #![allow(non_snake_case)] diff --git a/packages/rsx-rosetta/src/lib.rs b/packages/rsx-rosetta/src/lib.rs index 2ceb5f038..3c11f3a90 100644 --- a/packages/rsx-rosetta/src/lib.rs +++ b/packages/rsx-rosetta/src/lib.rs @@ -1,3 +1,7 @@ +#![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + use convert_case::{Case, Casing}; use dioxus_rsx::{ BodyNode, CallBody, Component, Element, ElementAttr, ElementAttrNamed, ElementName, IfmtInput, diff --git a/packages/rsx/src/lib.rs b/packages/rsx/src/lib.rs index f52ecad0e..bdf32b272 100644 --- a/packages/rsx/src/lib.rs +++ b/packages/rsx/src/lib.rs @@ -1,3 +1,6 @@ +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + //! Parse the root tokens in the rsx!{} macro //! ========================================= //! diff --git a/packages/server-macro/src/lib.rs b/packages/server-macro/src/lib.rs index 7cdc470d9..f739490d3 100644 --- a/packages/server-macro/src/lib.rs +++ b/packages/server-macro/src/lib.rs @@ -1,3 +1,7 @@ +// TODO: Create README, uncomment this: #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] + use convert_case::{Case, Converter}; use proc_macro::TokenStream; use proc_macro2::Literal; diff --git a/packages/signals/src/lib.rs b/packages/signals/src/lib.rs index 1f8bc3297..dce9af0a8 100644 --- a/packages/signals/src/lib.rs +++ b/packages/signals/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![warn(missing_docs)] mod rt; diff --git a/packages/ssr/src/lib.rs b/packages/ssr/src/lib.rs index 45e3f59ea..6794d1f14 100644 --- a/packages/ssr/src/lib.rs +++ b/packages/ssr/src/lib.rs @@ -1,4 +1,6 @@ #![doc = include_str!("../README.md")] +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] mod cache; pub mod config; diff --git a/packages/web/src/lib.rs b/packages/web/src/lib.rs index 60f84de37..944ed3150 100644 --- a/packages/web/src/lib.rs +++ b/packages/web/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] +#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![deny(missing_docs)] //! Dioxus WebSys