Allow chapters to have an optional TOML header

[azerupi]

The conclusion of the discussion #176 is to support an optional TOML header in the markdown sources to provide chapter specific information. Chapter specific information that overrides the global configuration for this specific chapter.

A chapter source file could look like the following:

------
author = "John Doe"
title = "A book of little words"
translator = "Jane Doe"
------

# Chapter title

The rest of the file is **normal** markdown

This will probably require some changes to the internal representation.

[steveklabnik]

The only thing I don't like about this is that then, they don't become standalone markdown files.

…

On Tue, May 16, 2017 at 2:54 PM, Mathieu David ***@***.***> wrote: The conclusion of the discussion #176 <https://github.com/azerupi/mdBook/issues/176> is to support an optional TOML header in the markdown sources to provide chapter specific information. Chapter specific information that overrides the global configuration for this specific chapter. A chapter source file could look like the following: ------ author = "John Doe" title = "A book of little words" translator = "Jane Doe" ------ # Chapter title The rest of the file is **normal** markdown This will probably require some changes to the internal representation. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <https://github.com/azerupi/mdBook/issues/277>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABsirvgFysNdNnhoBoJsvF4g85ytX6Mks5r6fDlgaJpZM4Nc7kl> .

[subthedubdub]

Is it planned for key-value pairs in the TOML header to be available for handlebars templating?

[Michael-F-Bryan]

@mkovarik, we haven't done much towards adding a TOML header just yet, but I'm assuming it would be implemented by adding a metadata field to the Chapter struct which gets filled in during the load_chapter() process. All renderers would then see this field, so it'd be trivial for the HTML renderer to pass the key-value pairs through to the templates.

Did you have a particular use case in mind?

[y9c]

@Michael-F-Bryan That is useful for migrating from markdown blog into mdbook. Meanwhile metadata for 'create date', 'last modify date' and 'keywords' can be preserved.

[brendanzab]

This could be really useful for letting us specify HTML metadata. I think this is what docusaurus does, for example.