Clarify readme #834
Open
Clarify readme #834
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sandstrom
commented
Oct 13, 2025
sandstrom
commented
- Use https for links
- Move license info down to relevant section (no need to have it at the top)
gettalong
requested changes
Oct 13, 2025
README.md
Outdated
| ## Introduction | ||
|
|
||
| kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and | ||
| kramdown is a fast, pure Ruby Markdown converter, using a strict syntax definition and |
There was a problem hiding this comment.
kramdown does not just convert Markdown but really a Markdown superset. So please remove that change.
README.md
Outdated
| **doc/quickref.page** or online at <https://kramdown.gettalong.org/quickref.html>. | ||
|
|
||
| The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However, | ||
| The kramdown library is mainly written to support the markdown-to-HTML conversion chain. However, |
There was a problem hiding this comment.
Using "kramdown" instead of "Markdown" is done intentionally as kramdown-the-syntax is more than Markdown-the-syntax. Markdown is "another input format".
| If you use kramdown in a commercial setting, please consider contributing back any | ||
| changes for the benefit of the community, or [becoming a sponsor](https://github.com/sponsors/gettalong/) | ||
| or [a patron](https://www.patreon.com/gettalong) - thanks! | ||
|
|
There was a problem hiding this comment.
Please use the original wording.
|
@gettalong I've updated the PR, trying to match your comment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.