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

Disable fuzzy link and include autolink feature in UG #1779

Merged
merged 4 commits into from
Feb 20, 2022

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Feb 16, 2022

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:
Partially address #1774
Add documentation to include example usage with URL and email, as well as some tricks to escape link conversion.

  • fix one test

Anything you'd like to highlight / discuss:

  • GitHub's similar autolink feature is documented here
  • Seems like there is no proper way to disable this on GitHub, workarounds can be found here

Testing instructions:
Check PR preview UG section here

Proposed commit message: (wrap lines at 72 characters)
Disable fuzzy link and mention autolink feature in UG


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt requested a review from ong6 February 16, 2022 12:45
Copy link
Contributor

@ryoarmanda ryoarmanda left a comment

Choose a reason for hiding this comment

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

Thanks for the work @tlylt, LGTM! I guess we can add some functional tests too that documents our chosen behaviour to the codebase (even though we don't control much of the linkify process, I think it's good to at least have it in tests for future reference if there is something to be tweaked)

Copy link
Contributor

@ryoarmanda ryoarmanda left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone Feb 18, 2022
@jonahtanjz jonahtanjz merged commit 545115f into MarkBind:master Feb 20, 2022
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.

None yet

3 participants