Open TheComputerM opened 4 years ago
I'd love to have a clue as to the depth, like <section data-depth="0">
!
Nevermind, looks like that's already in ;)
Is it possible to add an id
to every section, depending on current heading
?
That functionality isn't built into this plugin, but it is possible. Here's an example.
// This rehype plugin traverses <section> elements in the document, and if that section's first
// child is a heading (h1, h2, etc), it moves that child's `id` attribute to the section element.
const visit = require('unist-util-visit-parents')
const MAX_HEADING_DEPTH = 6
const HEADINGS = ["h1", "h2", "h3", "h4", "h5", "h6"]
module.exports = plugin
function plugin () {
return transform
}
function transform (tree) {
visit(
tree,
node => node.tagName === "section",
update
)
}
function update (section) {
if (section.children && section.children[0] && HEADINGS.includes(section.children[0].tagName)) {
const heading = section.children[0]
const { id, ...rest } = heading.properties
section.properties.id = id
heading.properties = rest
}
}
The code above is a rehype plugin: it transforms HTML ASTs, not Markdown ASTs. Add it to your project and name it something sensible, like rehype-heading-ids-to-section-ids.js
. Then to use it, you'd do something like this.
var unified = require("unified") // unified is the text processing interface that powers remark and rehype
var processor = unified()
.use(require("remark-parse")) // parse markdown text to an AST
.use(require("remark-sectionize")) // wraps stuff in sections (transforming the AST)
.use(require("remark-rehype")) // convert the markdown AST to an HTML AST
.use(require("rehype-slug")) // adds `id` attributes to headings
.use(require('./rehype-heading-ids-to-section-ids.js')) // the filename for the above plugin code
.use(require("rehype-stringify")) // convert the modified HTML AST to a string
var outputHTML = processor.process(inputMarkdown)
There's no reason that you couldn't modify the plugin shown above to operate directly on the Markdown AST, but I didn't have sample code handy for that.
Oh man thank you, this is great!
You're welcome! 🙂
This should be included as an option for this plugin
@aquaductape ended up creating my own plugin:
https://github.com/jrson83/jrson.me/blob/main/plugins/unified/rehype/rehypeSectionize.ts
For example give the section a unique id based on the heading text content