swaits/dioxus
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Include README and Dioxus logo in package docs (#1536)

Browse Source 
* Include README in docs.rs and add Dioxus logo

* Update README.md
This commit is contained in:
Leonard authored and GitHub committed 2023-10-10 10:52:48 -05:00
1 parent c65a49fd0f
commit 2d1234c3d1
26 files changed
+80 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

examples/query_segments_demo/src/main.rs
+1 -1
View File
@@ -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 <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.
impl FromQuery for BlogQuerySegments { impl FromQuery for BlogQuerySegments {
fn from_query(query: &str) -> Self { fn from_query(query: &str) -> Self {
let mut name = None; let mut name = None;
packages/autofmt/src/lib.rs
+4
View File
@@ -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 std::fmt::{Display, Write};
use crate::writer::*; use crate::writer::*;
packages/check/README.md
+2 -2
View File
@@ -6,7 +6,7 @@
[![Discord chat][discord-badge]][discord-url] [![Discord chat][discord-badge]][discord-url]
[crates-badge]: https://img.shields.io/crates/v/dioxus-autofmt.svg [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-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE [mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
[actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg [actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
@@ -16,7 +16,7 @@
[Website](https://dioxuslabs.com) | [Website](https://dioxuslabs.com) |
[Guides](https://dioxuslabs.com/learn/0.4/) | [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) [Chat](https://discord.gg/XgGxMSkvUM)
## Overview ## Overview
packages/check/src/lib.rs
+4
View File
@@ -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 check;
mod issues; mod issues;
mod metadata; mod metadata;
packages/cli/src/lib.rs
+4
View File
@@ -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 const DIOXUS_CLI_VERSION: &str = "0.4.1";
pub mod builder; pub mod builder;
packages/core-macro/src/lib.rs
+4
View File
@@ -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 proc_macro::TokenStream;
use quote::ToTokens; use quote::ToTokens;
use rsx::RenderCallBody; use rsx::RenderCallBody;
packages/core/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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)] #![warn(missing_docs)]
mod any_props; mod any_props;
packages/dioxus-tui/src/lib.rs
+4
View File
@@ -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; mod element;
use std::{ use std::{
packages/dioxus/src/lib.rs
+4
View File
@@ -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; pub use dioxus_core as core;
#[cfg(feature = "hooks")] #[cfg(feature = "hooks")]
packages/fermi/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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 mod prelude {
pub use crate::*; pub use crate::*;
packages/hooks/src/lib.rs
+3
View File
@@ -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))] #![cfg_attr(feature = "nightly-features", feature(debug_refcell))]
#[macro_export] #[macro_export]
packages/html/src/lib.rs
+3
View File
@@ -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)] #![allow(non_snake_case)]
//! # Dioxus Namespace for HTML //! # Dioxus Namespace for HTML
packages/interpreter/src/lib.rs
+4
View File
@@ -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 INTERPRETER_JS: &str = include_str!("./interpreter.js");
pub static COMMON_JS: &str = include_str!("./common.js"); pub static COMMON_JS: &str = include_str!("./common.js");
packages/liveview/src/lib.rs
+4
View File
@@ -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 { pub mod adapters {
#[cfg(feature = "warp")] #[cfg(feature = "warp")]
pub mod warp_adapter; pub mod warp_adapter;
packages/mobile/src/lib.rs
+2
View File
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")] #![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::*; pub use dioxus_desktop::*;
packages/native-core-macro/src/lib.rs
+4
View File
@@ -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; extern crate proc_macro;
use std::collections::HashSet; use std::collections::HashSet;
packages/native-core/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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)] #![warn(missing_docs)]
use std::any::Any; use std::any::Any;
packages/rink/src/lib.rs
+4
View File
@@ -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 crate::focus::Focus;
use anyhow::Result; use anyhow::Result;
use crossterm::{ use crossterm::{
packages/router-macro/src/lib.rs
+4
View File
@@ -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; extern crate proc_macro;
use layout::Layout; use layout::Layout;
packages/router/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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)] // cannot use forbid, because props derive macro generates #[allow(missing_docs)]
#![deny(missing_docs)] #![deny(missing_docs)]
#![allow(non_snake_case)] #![allow(non_snake_case)]
packages/rsx-rosetta/src/lib.rs
+4
View File
@@ -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 convert_case::{Case, Casing};
use dioxus_rsx::{ use dioxus_rsx::{
BodyNode, CallBody, Component, Element, ElementAttr, ElementAttrNamed, ElementName, IfmtInput, BodyNode, CallBody, Component, Element, ElementAttr, ElementAttrNamed, ElementName, IfmtInput,
packages/rsx/src/lib.rs
+3
View File
@@ -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 //! Parse the root tokens in the rsx!{} macro
//! ========================================= //! =========================================
//! //!
packages/server-macro/src/lib.rs
+4
View File
@@ -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 convert_case::{Case, Converter};
use proc_macro::TokenStream; use proc_macro::TokenStream;
use proc_macro2::Literal; use proc_macro2::Literal;
packages/signals/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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)] #![warn(missing_docs)]
mod rt; mod rt;
packages/ssr/src/lib.rs
+2
View File
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")] #![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; mod cache;
pub mod config; pub mod config;
packages/web/src/lib.rs
+2
View File
@@ -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)] #![deny(missing_docs)]
//! Dioxus WebSys //! Dioxus WebSys