Skip to content

Commit 46273ae

Browse files
not-my-profilerossmacarthur
authored andcommitted
docs: Prominently mention GitHub sluggification
Resolves #3.
1 parent 1cc173f commit 46273ae

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[![Build Status](https://badgers.space/github/checks/rossmacarthur/pulldown-cmark-toc/trunk?label=build)](https://github.com/rossmacarthur/pulldown-cmark-toc/actions/workflows/build.yaml?branch=trunk)
66

77
Generate a table of contents from a Markdown document.
8+
By default the heading anchor calculation (aka the "slugification")
9+
is done in a way that attempts to mimic GitHub's (undocumented) behavior.
810

911
## Getting started
1012

src/lib.rs

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
//! Generate a table of contents from a Markdown document.
22
//!
3+
//! By default the heading anchor calculation (aka the "slugification")
4+
//! is done in a way that attempts to mimic GitHub's (undocumented) behavior.
5+
//! (Though you can customize this with your own [`slug::Slugify`] implementation).
6+
//!
37
//! # Examples
48
//!
59
//! ```

0 commit comments

Comments
 (0)