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.
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.
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: