Skip to content

Instantly share code, notes, and snippets.

@jacksonj04
Created December 14, 2022 15:56
Show Gist options
  • Save jacksonj04/f817f649fc973263209bde2e5d2564a8 to your computer and use it in GitHub Desktop.
Save jacksonj04/f817f649fc973263209bde2e5d2564a8 to your computer and use it in GitHub Desktop.

Repository dashboards

How we built the Find Case Law repository dashboard.

tl;dr

It's a table in Markdown, which uses shields.io to display various status items, and the Markdown is rendered by a script to simplify updates

Why Markdown?

We use Markdown because it renders nicely in GitHub.

Why shields.io?

The content of each shield image is dynamic, meaning it can display changing status without having to modify the document itself.

Why script-generated?

The complexity of the syntax for tables plus the number of repositories, however means that we use a small script to actually assemble the document.

You could do it by hand, but you'd get annoyed very quickly.

Why those columns?

They're the ones which seemed most useful to the people working on Find Caselaw. We've adjusted the columns on display and their ordering a few times to better suit our needs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment