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

Configurable headline slug generation #244

Closed
codingluke opened this issue Aug 3, 2023 · 2 comments
Closed

Configurable headline slug generation #244

codingluke opened this issue Aug 3, 2023 · 2 comments

Comments

@codingluke
Copy link

codingluke commented Aug 3, 2023

Dear marksman team,
Thank you very much for your effort. Because of projects like this, neovim gets from year to year better to work with :)

I just encountered something using docusaurus.io and marksman together. In docusarurus it is possible to add emojis with the :smiley: syntax.

Given a title # :smiley: This is a friendly header, docusaurus sripes out the whole :smiley: part. The anchor-slug will be #-this-is-a-friendly-header. On the other hand marksman is only removing the special chars and ends up with #smiley-this-is-a-friendly-header.

At the end of the day I can choose of a not working link or a shouting marksman linter ;) There are two ways to fix this:

  1. Docusaurus is changing the heading-slug generation (or gives the possibility to change it)
  2. Marksman is changing the heading-slug generation (or gives the possibility to change it)

In my opinion, as marksman is kind of meta, the configuration should be possible here, what do you think?

Best Codingluke

@codingluke
Copy link
Author

closed as docusaurus is seeing this as a bug an will adapt their slugifying mechanism. Thanks to marksmans linter I found this :)

@artempyanykh
Copy link
Owner

Thanks for the kind words @codingluke! And happy to hear that the problem is going to be resolved on the docusaurus end.

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

2 participants