search

timwis / jkan

A lightweight, backend-free open data portal, powered by Jekyll
https://jkan.io
MIT License
218 stars 310 forks source link

When should we markdownify things? #274

Closed BryanQuigley closed 4 months ago

BryanQuigley commented 1 year ago

In ODP we added, markdownify in several places: https://github.com/azavea/opendataphilly-jkan/commit/d30da95d92bbca55e35efe12213856771f201343 https://github.com/azavea/opendataphilly-jkan/commit/5b8cd10218b455122e6b65364ef5a3df547a4fe0

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?

timwis commented 1 year ago

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.

BryanQuigley commented 1 year ago

I did consider the main content, but that seems like a much bigger change to how things work.