html_outliner/
lib.rs

1/*!
2# HTML Outliner
3
4Outline HTML documents for better SEO.
5
6## Examples
7
8```rust
9use html_outliner::Outline;
10
11const MAX_DEPTH: usize = 50;
12
13let outline = Outline::parse_html(r"
14<h1>Header Top</h1>
15<h1>Header 1</h1>
16<h2>Header 2</h2>
17<h3>Header 3</h3>
18<h4>Header 4</h4>
19<h5>Header 5</h5>
20<h6>Header 6</h6>
21", MAX_DEPTH);
22
23println!("{}", outline);
24
25/*
261. Header Top
272. Header 1
28    1. Header 2
29        1. Header 3
30            1. Header 4
31                1. Header 5
32                    1. Header 6
33*/
34```
35*/
36
37mod heading;
38mod outline;
39mod outline_structure;
40mod sectioning_type;
41
42pub use heading::Heading;
43pub use outline::Outline;
44pub use outline_structure::OutlineStructure;
45pub use sectioning_type::SectioningType;