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

feat: add GitHub flavored markdown syntax [joplin-search-integration] #106

Merged

Conversation

jannikgohr
Copy link

@jannikgohr jannikgohr commented Oct 11, 2024

Add support for some GitHub flavored Markdown syntax, which is also supported in Joplin by default

New Syntax supports:

  • autolink literals
  • footnotes
  • strikethrough
  • tables
  • tasklists

Examples:

autolink literals

Links become clickable by default even when not marked as link in Markdown

Rendered:
https://example.com
Markdown:
https://example.com

footnotes

Rendered:
Here's a sentence with a footnote. 1

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

strikethrough

Rendered:
strikethrough
Markdown:
~~strikethrough~~

tables

Rendered:

Syntax Description
Header Title
Paragraph Text
Markdown:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

tasklists

Rendered (but not interactive in Joplin-search-integration):

  • Write the press release
  • Update the website
  • Contact the media

Markdown:

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

With this we should support most of Joplin's Markdown syntax

Footnotes

  1. This is the footnote.
    Markdown:

@rxliuli rxliuli merged commit a848501 into rxliuli:master Oct 12, 2024
1 of 2 checks passed
@rxliuli
Copy link
Owner

rxliuli commented Oct 12, 2024

Released https://github.com/rxliuli/joplin-utils/releases/tag/joplin-search-integration%400.10.3


Sorry, I am traveling, so my response is slower.

@jannikgohr
Copy link
Author

No problem, thanks for the great work!

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