Read the document title from file.data.title

[Delapouite]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Problem

Hi

Currently the title of the document is assigned like this:

const title = options.title || file.stem

There are a few situations where this value, may have been extracted/computed upstream in the processor.

• by reading the #+title: keyword if starting from an Org document
• by looking at the unique h1 element if starting from HTML document
• …

Therefore, it would be great if this plugin would also have a look at data aggregated on the vfile.

Solution

If this is ok with you, I can prepare a PR with the following change and the associated documentation:

const title = options.title || file.data.title || file.stem

Thanks.

Alternatives

[wooorm]

Yeah, good idea I think.
rehype-meta supports this too: https://github.com/rehypejs/rehype-meta#title
It configures from file.data.meta: https://github.com/rehypejs/rehype-meta#title

This is also populated by https://github.com/rehypejs/rehype-infer-title-meta

So I think I'd prefer a little more privacy with file.data.meta, but otherwise good! 👍

[wooorm]

solved in https://github.com/rehypejs/rehype-document/releases/tag/7.0.0!