Add configuration to enable ordered list #117
Merged
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
* Created new configuration option to enable ordered list through use_ordered_list input * Default behaviour is false so users will continue to have ul tags * Using existing class configuration, user can change styling on top ol tag and sub listing ol tags separately * No ability to update styling on sub-nested ol tags separately but code is open to this change * Added tests for new logic * Update README with example of usage and render
|
I totally missed that another user opened this exact issue #71. Hope that this PR will be considered! Also I am not sure why the builds above are not running? |
|
@toshimaru friendly ping |
|
@zsyed91 Sorry, I totally missed your ping. |
|
I'd say the code base is a bit old? (That's why the CI doesn't run, I guress) |
toshimaru
requested changes
Sep 5, 2020
|
Seems no response for my review, but I'm gonna take this PR. |
Merged
|
Thanks, I too missed this ping! Relocating but that's done. Thanks for
merging this change. Let me know if there are any follow ups needed.
…On Mon, Oct 12, 2020, 10:18 AM Toshimaru ***@***.***> wrote:
Merged #117 <#117> into
master.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#117 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AB2R3DCS7NNSAT2JDSJOZELSKMM3DANCNFSM4OI6QMNQ>
.
|
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.
Overview
By default
jekyll-tocgenerates the HTML using unordered lists. If users desire ordered lists for their table of contents they cannot do so easily. With the changes below, the default behavior of using unordered lists will remain. However a new configuration option will toggle between<ul></ul>and<ol></ol>tags accordingly.With the changes, users can add the existing custom classes to the top level heading and sub-headings separately. That way they can style the top heading and sub-headings separately. In this pass, I did not add the functionality to style multiple nested sub-headings but rather just all sub-headings using the existing configuration. If we feel that this would be useful, we can extend the current logic in the PR to inject classes similar to the list items so end users can style each sub-heading separately. This might be overkill so for simplicity, I have left it to just top level heading and sub-headings.
Changes in PR
Related Issues