Skip to content

Commit

Permalink
Fix docs due to doc(include) issues
Browse files Browse the repository at this point in the history
  • Loading branch information
thedodd committed Jul 26, 2021
1 parent a011d3b commit 458598f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ybc"
version = "0.2.0"
version = "0.2.1"
description = "A Yew component library based on the Bulma CSS framework."
authors = ["Anthony Dodd <dodd.anthonyjosiah@gmail.com>"]
edition = "2018"
Expand Down
20 changes: 18 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
#![cfg_attr(feature = "docinclude", feature(external_doc))]
#![cfg_attr(feature = "docinclude", doc(include = "../README.md"))]
//! A [Yew](https://yew.rs) component library based on the [Bulma CSS](https://bulma.io) framework.
//!
//! 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.
//!
//! What does it look like to use YBC? The following is a snippet of a component's `view` method
//! rendering a navbar, a fluid container, and some tiles.
//!
//! Please see [this project's README](https://github.com/thedodd/ybc) for the example. **Docs.rs is
//! currently (2021.07.26) slightly broken and having trouble including external docs as it has historically.**
// TODO: add this back in once it is no longer a land mine:
// #![cfg_attr(feature = "docinclude", doc = include_str!("../README.md"))]
#![recursion_limit = "1024"]

mod columns;
Expand Down

0 comments on commit 458598f

Please sign in to comment.