Move Markdown to inside the compiler. #8115
Conversation
The Markdown module is buggy and not feature complete. We shouldn't expose it in the standard library. For the compiler's purposes (`crystal doc`) it might be good but users should be encouraged to use a better library. Eventually the `crystal doc` tool should somehow use a different, better markdown library.
|
This light markdown is very useful for simple cases i.e. doc generation. It's being used by Amber's html helpers. The reason given for hiding this was to encourage use of |
|
I would recommend trying to optimize markd. You can also use the internal. Markdown type, it will still work but it's not recommended. |
|
Also if you tell me how it's slow I can try to optimize it because I like those problems. |
|
I’m not sure why but the creator has benchmarks. We don’t need full markdown. I guess we can extract what we need and write our own. 😔
…Sent from my iPhone
On Sep 7, 2019, at 1:18 AM, Ary Borenszweig ***@***.***> wrote:
Also if you tell me how it's slow I can try to optimize it because I like those problems.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
@drujensen I'm currently optimizing markd, it's fun :-) So far I went from 11.21 times slower than std's Markdown to 5.40 times slower. It's still slower, but the gap is getting smaller. And I plan to continue optimizing. Of course it won't reach std's performance because std is incomplete and has bugs and implementing the missing stuff will make it slower. In fact maybe we should eventually just move markd into the standard library somehow and use it for the docs. |
-> #4613 |
This reverts commit 491f26b.
Additionally, no longer use the Crystal "markdown" library which has been removed from the Crystal stdlib in version 0.31.0. See crystal-lang/crystal#8115. Also fix some deprecation warnings using the following commands: find . \( -type d -name .git -prune \) -o -type f -exec sed -i 's/URI\.escape/URI\.encode_www_form/g' "{}" \; find . \( -type d -name .git -prune \) -o -type f -exec sed -i 's/URI\.unescape/URI\.decode_www_form/g' "{}" \; sed -i 's/while \%pull\.kind \!\= \:end_object/until \%pull\.kind\.end_object\?/g' src/invidious/helpers/patch_mapping.cr
…te dependencies (#764) * shard: update to crystal 0.31.0 Additionally, no longer use the Crystal "markdown" library which has been removed from the Crystal stdlib in version 0.31.0. See crystal-lang/crystal#8115. Also fix some deprecation warnings using the following commands: find . \( -type d -name .git -prune \) -o -type f -exec sed -i 's/URI\.escape/URI\.encode_www_form/g' "{}" \; find . \( -type d -name .git -prune \) -o -type f -exec sed -i 's/URI\.unescape/URI\.decode_www_form/g' "{}" \; sed -i 's/while \%pull\.kind \!\= \:end_object/until \%pull\.kind\.end_object\?/g' src/invidious/helpers/patch_mapping.cr
The Markdown module is buggy and not feature complete. We shouldn't expose it in the standard library. For the compiler's purposes (`crystal doc`) it might be good but users should be encouraged to use a better library. Eventually the `crystal doc` tool should somehow use a different, better markdown library.
The Markdown module is buggy and not feature complete. We shouldn't expose it in the standard library. For the compiler's purposes (
crystal doc) it might be good but users should be encouraged to use a better library. Eventually thecrystal doctool should somehow use a different, better markdown library.If with time we decide to improve it and make it feature complete and without bugs we could consider re-exposing it again. But right now this can't go like this in 1.0.
Related to #7463, #7009, #4613, #8113