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

chore: optimize readme #81

Merged
merged 2 commits into from
Jul 8, 2024
Merged

chore: optimize readme #81

merged 2 commits into from
Jul 8, 2024

Conversation

hirasso
Copy link
Member

@hirasso hirasso commented Jul 8, 2024

Description

Today I noticed that on the docs page of fragment plugin there were a few broken headline links. Turns out that this was caused by markdown-it/linkify-it, that considered both rule.to as well as rule.name to be URLs.

Wrapping those in backticks disabled the falsy linkification.

Drive-By

  • use new style for notes and tips
  • smaller content tweaks

Checks

  • The PR is submitted to the master branch
  • The code was linted before pushing (npm run lint)

`rule.to` or `rule.name` are being converted to links by [markdown-it/linkify-it](https://github.com/markdown-it/linkify-it). Let's fix it here instead of the docs (I couldn't find a simple enough fix in the docs for it).
Turns out wrapping the headings in backticks disables `linkify-it` 🤠
Copy link

github-actions bot commented Jul 8, 2024

Playwright test results

passed  12 passed

Details

stats  12 tests across 1 suite
duration  
commit  fef627b

@hirasso hirasso requested a review from daun July 8, 2024 13:07
@hirasso hirasso mentioned this pull request Jul 8, 2024
2 tasks
Copy link
Member

@daun daun left a comment

Choose a reason for hiding this comment

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

🧹

@hirasso hirasso merged commit 05db9d4 into master Jul 8, 2024
3 checks passed
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

Successfully merging this pull request may close these issues.

2 participants