Use a more robust table of contents renderer #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SteveMarshall
force-pushed
the
fix-table-of-contents-liquid-rendering
branch
from
288e01c
to
32492b5
Compare
digitalronin
approved these changes
Aug 30, 2017
It turns out that @allejo, who I found on #jekyll in Freenode, has written [a pure Liquid table of contents renderer](https://allejo.io/blog/a-jekyll-toc-in-liquid-only/) that works based on the final, rendered HTML rather than the Markdown. This means it doesn't have problems with headers that are generated by Liquid logic, and is thus more robust than my table of contents generator. Given that, we can just integrate that table of contents rendered. This also adds the appropriate attribution for our use of @allejo's code. The table of contents include does the following: 0. Accept, as input, the page content rendered as HTML (and, thus, already parsed by Liquid) 1. Split the HTML on `<h` and loop over the resulting `nodes` (making each `node` contain the remainder of the opening tag, and everything up to the next `<h`) 2. Generate new Markdown for each `node` by deconstructing the HTML up to the first `</h` (excluding headers and stripping markup according to input parameters) 5. Passes the rendered Markdown (in `my_toc`) through `markdownify` to output it.
SteveMarshall
force-pushed
the
fix-table-of-contents-liquid-rendering
branch
from
32492b5
to
8d2ae92
Compare
Now we have a more robust way to render tables of contents, we don't have to exclude Jekyll-generated headers on the homepage, and don't have to do our own set of markdown-mangling. Yay!
SteveMarshall
force-pushed
the
fix-table-of-contents-liquid-rendering
branch
from
8d2ae92
to
e51091f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It turns out that @allejo, who I found on #jekyll in Freenode, has written a pure Liquid table of contents renderer that works based on the final, rendered HTML rather than the Markdown. This means it doesn't have problems with headers that are generated by Liquid logic, and is thus more robust than my table of contents generator.
Given this code already exists, this PR incorporates it (attributing correctly), and makes use of it in our layout.