Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support specifying the style of the generated unordered list markup #263

Open
brlin-tw opened this issue Oct 8, 2024 · 0 comments
Open

Comments

@brlin-tw
Copy link

brlin-tw commented Oct 8, 2024

The markdownlint pre-commit hook errored in my project after running doctoc because the style of the unordered list is inconsistent with the others:

Screenshot of the markup of the generated TOC
Screenshot of the markup of the other content

$ pre-commit run markdownlint --files README.md
markdownlint.............................................................Failed
- hook id: markdownlint
- exit code: 1

README.md:20:1 MD004/ul-style Unordered list style [Expected: plus; Actual: dash]
README.md:21:1 MD004/ul-style Unordered list style [Expected: plus; Actual: dash]
README.md:41:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
README.md:44:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

It would be great if doctoc supports customizing the style of the unordered list so such inconsistency won't occur, specifically:

  • The bullet type used in each level of the unordered list
  • The indentation width
  • The indentation type: space/tab

Thanks in advance!

@brlin-tw brlin-tw changed the title Support specifying the style of the unordered list markup Support specifying the style of the generated unordered list markup Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant