When should we markdownify things?
BryanQuigley opened this issue · comments
In ODP we added, markdownify in several places:
opendataphilly/opendataphilly-jkan@d30da95
opendataphilly/opendataphilly-jkan@5b8cd10
In certain cases, we ended up tweaking datasets to make them look better as enabling all markdown can make the datasets list page messy.
Should we enable Markdown in more places upstream?
Yeah, great idea 👍🏻 Sounds like it would be a non-breaking change as well, right?
The only other thing to consider is that we could use the main content for that. For example:
---
title: Sample Dataset
organization: Commerce Department
---
Multi-line
_markdown description_
**goes here**In the template, we'd then just write {{ content }} if I recall correctly.
But I think keeping it as a front-matter field probably makes more sense, because (a) the editor UI makes it a nice user experience anyway, and (b) we may want to use the content area for something else, like visualizations, in the future.
Btw, we can probably update the editor UI to use a markdown/rich text field for this.
I did consider the main content, but that seems like a much bigger change to how things work.