hyperchad_docs_site 0.4.0

HyperChad documentation site framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
#![allow(clippy::multiple_crate_versions)]

//! Reusable `HyperChad` documentation site framework.
//!
//! ```no_run
//! use hyperchad_docs_site::{DocPage, DocsSection, DocsSite};
//!
//! fn generated_reference() -> String {
//!     "# Reference".to_string()
//! }
//!
//! static SECTIONS: &[DocsSection] = &[DocsSection::new("reference", "Reference")];
//! static PAGES: &[DocPage] = &[DocPage::generated("/docs/reference", generated_reference)
//!     .title("Reference")
//!     .nav("reference", "Reference")];
//!
//! let site = DocsSite::builder("my-project")
//!     .title("my-project docs")
//!     .description("Documentation for my-project")
//!     .sections(SECTIONS)
//!     .pages(&PAGES)
//!     .build();
//! # let _ = site;
//! ```

pub mod assets;
pub mod generated;
pub mod link_map;
pub mod markdown;
pub mod registry;
pub mod site;
pub mod theme;

pub use generated::{CliReference, ConfigReference, EnvOverrideDoc, SectionHeadingStyle};
pub use registry::{DocPage, DocsSection, NavItem, NavSection, PageKind};
pub use site::{DocsSite, DocsSiteBuilder, HeaderLink, MarkdownScan, PageShell, ShellContext};
pub use theme::Theme;