Skip to content

Commit

Permalink
Include README in docs for docs.rs.
Browse files Browse the repository at this point in the history
  • Loading branch information
thedodd committed Sep 17, 2020
1 parent 4a26c67 commit 854e457
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
12 changes: 2 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down

0 comments on commit 854e457

Please sign in to comment.