Skip to content

feat(toc_obj): Support unnumbered headings#269

Merged
yoshinorin merged 5 commits intohexojs:masterfrom
Cerallin:master
Jan 29, 2022
Merged

feat(toc_obj): Support unnumbered headings#269
yoshinorin merged 5 commits intohexojs:masterfrom
Cerallin:master

Conversation

@Cerallin
Copy link
Contributor

@Cerallin Cerallin commented Jan 11, 2022

This PR adds a feature for unnumbered headings.

  1. The user specifies unnumbered_class_list and passes it to tocObj.
  2. Headings WITHOUT classes in unnumbered_class_list will be parsed as usual.
  3. Headings WITH classes in unnumbered_class_list will be parsed with unnumbered: true.

As is provided in test/toc_obj.spec.js, I have made minimized modifications as much as possible.

P.S. Maybe unnumbered_class_list is too long?

SukkaW
SukkaW requested changes Jan 11, 2022
View reviewed changes
SukkaW
SukkaW reviewed Jan 14, 2022
View reviewed changes
yoshinorin
yoshinorin reviewed Jan 15, 2022
View reviewed changes
Copy link
Member

@yoshinorin yoshinorin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Cerallin
Would you please update README?

https://github.com/hexojs/hexo-util/tree/ab5ad9dd906f865faeba846b92be9dcce8c27120#tocobjstr-options

P.S: no need force-push. we will squash-merge.

SukkaW
SukkaW reviewed Jan 16, 2022
View reviewed changes
@yoshinorin yoshinorin mentioned this pull request Jan 19, 2022
Closed
2 tasks
yoshinorin
yoshinorin requested changes Jan 19, 2022
View reviewed changes
Copy link
Member

@yoshinorin yoshinorin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Cerallin
Would you please fix lint?

@Cerallin Cerallin mentioned this pull request Jan 19, 2022
Merged
2 tasks
@yoshinorin
Copy link
Member

yoshinorin commented Jan 22, 2022

@Cerallin
Continues from hexojs/hexo#4871 (comment)

Do you have any idea to use this option with other renderers? Currently, hexo-renderer-marked and hexo-renderer-markdown-it don't have an option to add custom attributes. They are the official renderer of hexo. IMHO, it is better to use this option with official renderers.

If difficult to implement it, would you please update the docs that users need to customize (extends) the renderer by themselves to add an attributes.

I assume users will be confused "this option can be used in official renderers by default".

@SukkaW
Do you have any suggestions?

@Cerallin
Copy link
Contributor Author

Cerallin commented Jan 22, 2022 •
edited
Loading

@yoshinorin
This is a plugin for markdown-it: markdown-it-attrs.
And for marked, maybe we need to implement the feature by ourselves.

@Cerallin
Copy link
Contributor Author

Cerallin commented Jan 25, 2022

Support for markdown-it-attrs is added via hexojs/hexo-renderer-markdown-it#174.

@yoshinorin yoshinorin merged commit 837008b into hexojs:master Jan 29, 2022
nevilm-lt pushed a commit to nevilm-lt/hexo-util that referenced this pull request Apr 22, 2022
@Cerallin @nevilm-lt
feat(toc_obj): Support unnumbered headings (hexojs#269)
6c4992e 
* feat(toc_obj): Support unnumbered headings

* Update readme

* Rollback TOC

* Fix typo

* Fix lint
nevilm-lt pushed a commit to nevilm-lt/hexo-util that referenced this pull request Apr 22, 2022
@Cerallin @nevilm-lt
feat(toc_obj): Support unnumbered headings (hexojs#269)
f701ba5 
* feat(toc_obj): Support unnumbered headings

* Update readme

* Rollback TOC

* Fix typo

* Fix lint
nevilm-lt pushed a commit to nevilm-lt/hexo-util that referenced this pull request Apr 22, 2022
@Cerallin @nevilm-lt
feat(toc_obj): Support unnumbered headings (hexojs#269)
a589c01 
* feat(toc_obj): Support unnumbered headings

* Update readme

* Rollback TOC

* Fix typo

* Fix lint
nevilm-lt pushed a commit to nevilm-lt/hexo-util that referenced this pull request Apr 22, 2022
@Cerallin @nevilm-lt
feat(toc_obj): Support unnumbered headings (hexojs#269)
cb85a8c 
* feat(toc_obj): Support unnumbered headings

* Update readme

* Rollback TOC

* Fix typo

* Fix lint
himanshiLt pushed a commit to himanshiLt/hexo-util that referenced this pull request Apr 25, 2022
@Cerallin @himanshiLt
feat(toc_obj): Support unnumbered headings (hexojs#269)
e0febd9 
* feat(toc_obj): Support unnumbered headings

* Update readme

* Rollback TOC

* Fix typo

* Fix lint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yoshinorin yoshinorin yoshinorin requested changes

@SukkaW SukkaW SukkaW approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Cerallin @yoshinorin @SukkaW