diff --git a/Cargo.toml b/Cargo.toml index b38285c..0fab4a7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -20,3 +20,7 @@ yew-router = { version="0.14.0", features=["web_sys"], optional=true } [features] default = ["router"] router = ["yew-router"] +docinclude = [] # Used only for activating `doc(include="...")` on nightly. + +[package.metadata.docs.rs] +features = ["docinclude"] # Activate `docinclude` during docs.rs build. diff --git a/src/lib.rs b/src/lib.rs index b9ba4f6..94386fa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,13 +1,5 @@ -//! YBC encapsulates all of the structure, style and functionality of the Bulma CSS framework -//! as a set of Yew components. YBC also ships with support for the Yew Router, adding -//! Bulma-styled components which wrap the Yew Router components for clean integration. -//! -//! As a guiding principal, YBC does not attempt to encapsulate every single Bulma style as a -//! Rust type, let alone the many valid style combinations. That would be far too complex, and -//! probably limiting to the user in many ways. Instead, YBC handles strucutre, required classes, -//! functionality, sane defaults and every component can be customized with any additional -//! classes for an exact look and feel. - +#![cfg_attr(feature = "docinclude", feature(external_doc))] +#![cfg_attr(feature = "docinclude", doc(include = "../README.md"))] #![recursion_limit = "1024"] mod columns;