search

simonw / django-sql-dashboard

Django app for building dashboards using raw SQL queries
https://django-sql-dashboard.datasette.io/
Apache License 2.0
437 stars 37 forks source link

Support markdown and/or HTML in dashboard descriptions #115

Closed toolness closed 3 years ago

toolness commented 3 years ago

In particular, I'm linking out to external sites in my dashboard descriptions, so it would be great to have those hyperlinked (currently the viewer has to manually copy/paste the URL, which is shown as plain text). Since the package already has both markdown and bleach as dependencies, it doesn't seem like this should be technically complex, although perhaps making it backwards-compatible might be non-trivial...

Anyways, happy to discuss this further and start a PR if it's deemed a good idea.

simonw commented 3 years ago

This is a great idea - especially since we already bundle the Markdown library for other purposes.

I think the simplest solution here would be to say that the dashboard description field supports markdown - I don't expect there to be wide enough deployments of the tool that treating existing descriptions as markdown is likely to break anything significant, though we'll still call it out in the release notes.

toolness commented 3 years ago

Nice! Would you like me to start a PR for this or any of the other issues? I'm interested in giving back to this codebase but I also understand if you'd rather do things yourself.

simonw commented 3 years ago

Would welcome a PR for this!

simonw commented 3 years ago

This is now released as version 0.16. https://github.com/simonw/django-sql-dashboard/releases/tag/0.16

simonw commented 3 years ago

Demo: https://simonwillison.net/dashboard/example-dashboard/