Use markd for markdown rendering in the compiler #11040
Merged
Conversation
This file contains 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
git-subtree-dir: lib/markd git-subtree-split: edde8d8990452b9a568016f8ef62f3d595e19d99
asterite
approved these changes
Jul 29, 2021
|
Glad the final chosen approach iswith Hopefully the Readme and License will remind us to submit patches upstream. |
sdogruyol
approved these changes
Jul 30, 2021
|
The newly generated docs are already live at https://crystal-lang.org/api/master/ Please let us know about any issues with the new renderer, discovered on https://crystal-lang.org/api/master/ or while building shards. |
|
Good news! I am happy to make this happened 😄 |
ghost
mentioned this pull request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a revival of #8174, pulling in https://github.com/icyleaf/markd/ and using it for markdown rendering in the docs generator and playground.
The markdown implementation we're currently using was previously part of the standard library but got yanked because it's broken. We still used it in the compiler. This finally replaces it with a dedicated library that is proven to work well.
To avoid external dependencies for the compiler, the markd shard is vendored into the Crystal repository using
git subtree. The entire code is embedded in the repository, but it's easy to pull in upstream changes usinggit subtree pull.The first two commits are just git subtree pulling in the code from markd.
Only the third commit is interesting for review, integrates markd with the compiler and adds specs to make sure the output is as expected and the mentioned bugs are indeed fixed.
The generated docs HTML is mostly identical with the previous implementation, except for some insignificant white space changes and more encoded special characters. And of course, a lot of broken behaviour is fixed.
Resolves #4613
Fixes #7009
Fixes #7463
Fixes #10058
NOTE: This must not be squash merged to keep the commit information for git subtree.