一个定义良好的 HTML 标题结构除了能让访客更轻松地浏览网页之外,也能够帮助搜索引擎更精确地理解 HTML 文档的内容,提高网站的搜索排名。那要如何使用 Rust 编程语言来产生 HTML 文档的标题大纲(Outline)呢?

HTML Outliner

「HTML Outliner」是笔者开发的套件,用以产生 HTML 文档的大纲。

Crates.io

Cargo.toml

html-outliner = "*"

使用方法

html_outliner 这个 crate 提供了 Outline 和 OutlineStructure 两种结构体。OutlineStructure 结构体是解析 HTML 文档之后的结果,仅把标题和章节型内容「Sectioning Content」从中区分出来,并未对标题等级进行处理。Outline 结构体则是将 OutlineStructure 结构体转为字符串的阶层结构后的结果,会去处理标题等级(例如 h1 后紧接 h2 的话,h2 会放在 h1 的下层)。

如果您想要使用这个 crate 提供的方式将 HTML 文档转成字符串大纲,可以直接使用 Outline 结构体的 parse_html 关联函数来转。程序如下:

use html_outliner::Outline;

const MAX_DEPTH: usize = 50;

let outline = Outline::parse_html(r"
<h1>Header Top</h1>
<h1>Header 1</h1>
<h2>Header 2</h2>
<h3>Header 3</h3>
<h4>Header 4</h4>
<h5>Header 5</h5>
<h6>Header 6</h6>
", MAX_DEPTH);

println!("{}", outline);

parse_html 关联函数的第二个参数是要访问的 HTML 元素的最高层数,如果太多层的话就会发生堆栈溢出(Stack Overflow),所以要进行合理的限制。

以上程序会输出:

1. Header Top
2. Header 1
    1. Header 2
        1. Header 3
            1. Header 4
                1. Header 5
                    1. Header 6