Markdown format #13
Open
Markdown format #13
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
srijitcoder
reviewed
Feb 16, 2024
Comment on lines
+7
to
+32
| <eox-map id="tour" .config=${{ | ||
| view:{ | ||
| center:[0,0], | ||
| zoom:7 | ||
| }, | ||
| layers:[ | ||
| { | ||
| type:"Tile", | ||
| properties: { | ||
| id: "foo" | ||
| }, | ||
| source:{ | ||
| type:"OSM" | ||
| } | ||
| }, | ||
| { | ||
| type:"Tile", | ||
| properties: { | ||
| id: "bar" | ||
| }, | ||
| source:{ | ||
| type:"OSM" | ||
| } | ||
| } | ||
| ] | ||
| }}></eox-map> |
There was a problem hiding this comment.
Isn't it better to avoid injecting html and js code directly into markdown but try to make it similar to the section pattern, something like this -
# eox-map { #tour center='[0,0]' zoom='7' layers='[{"type":"Tile","properties":{"id":"foo"},"source":{type:"OSM"}}]' }
There was a problem hiding this comment.
This will help us to avoid unnecessary code injection into the storytelling renderer and which may cause unnecessary output.
There was a problem hiding this comment.
I would also think we discussed not wanting to allow code injection. This is also why we moved away from concepts such as MDX and MDJS, right?
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.
It is quite tricky to find a good approach on how to use markdown for storytelling, as there are many possibilities, and I wonder how complicated we want to make things.
Ideally we wouldn't reinvent the wheel, and use something already existing (with just adding some small extensions on top). There is the "pandoc flavoured markdown" which includes already most of the basic needs I guess, and Quarto expanded on it by using both the markdown parts as well as some custom rendering for e.g. dashboards.
Someone even did experiments with creating a scrollytelling experience with quarto, although I believe that this would be the point where we would need some of our own extensions to the system.
We might be able to use quarto's renderer since it is now MIT.
In this PR, I am particularly not happy about how the eox-map looks. Also, this way, we really butcher the markdown file, so it becomes not readable any longer in pure GitHub rendering. Any suggestions are welcome, thank you. Please use the comment function to comment on individual lines of code.
Edit: I have created an alternative using HTML comments for everything, resulting in a readable md file on GitHub: https://github.com/EOX-A/storytelling/blob/markdown-format-alternative/map-steps.md?plain=1
This would be nice, but would be again a completely custom solution, not reusing other's.
Other resources: