This repository has been archived by the owner on Dec 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 356
Stop using roaster for rendering markdown #559
Merged
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
This allows us to use marked directly, but we need to implement two things that were provided by roaster: - Handle the yaml frontmatter tags. - Convert github emoji tags (e.g 🚀) to the actual emojis.
rafeca
force-pushed
the
deprecate-roaster
branch
from
April 23, 2019 18:37
832e085
to
3245335
Compare
In order to verify that the extension keeps working correctly, I've used the following markdown file: https://gist.github.com/rafeca/7220f08c6d7d340533b3c323290ac507 Using standard style: Using GitHub style: |
nathansobo
approved these changes
Apr 24, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This all seems reasonable. There's only one hole in the emoji handling I could think of, but I'm not sure it's worth fixing. If for some reason someone were to use an emoji string inside a URL, it would break rendering. Like this: [:finnadie:](https://foo.com/:finnadie:/)
. I think that's a valid URL, but I don't really think anybody would ever do something like this. So I say 🚢.
1 task
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Requirements
Description of the Change
In order to fix #206, the version of the
marked
package needed to be upgraded. Since this package depended onroaster
, which is unmaintained and not even recommended to be used by its own creator, I've opted to replace it by directly callingmarked
and implementing in this package the missing functionality.Alternate Designs
I could have forked
roaster
(in fact a really old fork of it already exists on the atom org: http://github.com/atom/roaster) and then upgrademarked
from that fork, but I prefer to avoid having yet another fork and yet another package to maintain.Benefits
Fixes #206
Possible Drawbacks
N/A
Applicable Issues
#206