New ToC and Footnotes data structures

[bep]

Go 1.11 is right around the corner. With that comes Go modules, which should solve the versioning issues we currently have with an upgrade to Blackfriday v2. I have started some investigations in another project.

The goal of this first "sprint" is to

1. Upgrade to BF2 in a way that makes it easy to plug in some hooks that we have described in other issues (URL rewriter etc.), allow for renderer per output format etc (HTML, LatEx ...).
2. Add some proper data structures for table of contents and foot notes

This issue discusses 2) Above.

For ToC we currently have this HTML .TableOfContents blob. We cannot remove that over night so I suggest we add a new "container" in Page that contains Markdown-related metadata.

• Name? .MD.TableOfContents?

That object will in the first go contain two data structures:

• .TableOfContents
• .Footnotes

For TableOfContents, I suggest a list of:

Title
Children
Parent

For Footnotes I suggest a list of:

ID
Link

Instead of Link maybe we should just reuse the term RelPermalink etc.

Note that the Footnotes list is meant to be used to render "somewhere else" in a template, so we also need a way to not render it in the main content.

[rdwatters]

Is it unrealistic to keep .TableOfContents with your default behavior above but instead add arguments for start/stop based on h element?

{{ .TableOfContents 2 3 }}

Or the same as your comment above by adding the .MD to my example?

[rdwatters]

I know you mentioned in the forums you're already thinking of even cooler ways to implement this, but piggybacking on my comment above, the ability to set this globally would be pretty slick too. Something to the effect of tocHeadingLevels (name could be much more clever, clearer). The idea being that a global config change affects all previously used instances of .TableOfContents. Just a thought....

[stale]

This issue has been automatically marked as stale because it has not had recent activity. The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.