Skip to main content
BRILLIQS

Evidence

A tool that builds reports from Markdown files containing SQL queries, producing a site rather than a dashboard.

Evidence builds data reports from files. A page is written in Markdown, with SQL queries embedded in it and components that display their results as charts or tables. Running the project produces a website. Because the pages are files, the whole report lives in version control alongside any other code.

A different shape of output

Most reporting tools produce dashboards: a grid of panels, interactive, viewed inside the tool.

Evidence produces documents. A page of written explanation with charts and tables in it, published as a website.

That difference is the first thing to weigh, because it decides whether the tool suits the requirement. For a reader who needs to explore, a dashboard is right. For a reader who needs to understand something somebody worked out, a document usually is.

Pages are files

A report page is a Markdown file. It contains three kinds of thing mixed together:

  • Written text, explaining what the figures mean.
  • SQL queries, each given a name.
  • Components, which display the result of a named query as a chart or a table.

The page is therefore self contained. The narrative, the queries and the visualisations are in one text file.

What being a file changes

Because pages are files, the whole reporting layer sits in version control.

Changes are reviewed. Altering a report is a commit that somebody reads before it is merged.

History exists. When a figure in last quarter's report looks wrong, the version that produced it is still there.

Reports are testable in a branch. A restructured report can be built and viewed without anyone else seeing it.

None of this is available when a report lives inside a tool's database as a set of saved settings.

The query is visible

Because SQL sits in the page, the query behind any chart is right there.

This addresses a persistent problem with reporting: somebody asks how a number was calculated, and answering means opening a tool, finding the chart, opening its definition and reading a query nobody has looked at in a year.

Here the answer is in the file next to the chart. That makes reports auditable in a way that is otherwise difficult.

Explanation alongside figures

Charts show what happened. They do not say what it means or what should be done, and that interpretation is usually the valuable part.

Because a page is Markdown, the commentary is written directly around the charts. A reader receives both, rather than a dashboard and a separate document that has already drifted out of date.

Publishing

Building the project produces a site, served like any other website.

That has a consequence worth noting: distributing a report to a large audience is a hosting question rather than a licensing one. There is no per reader cost and no platform for readers to log into.

Who Evidence suits

Evidence suits analysts and engineers comfortable with SQL and text files, teams that already work through version control, and organisations producing recurring written reports where the explanation matters as much as the figures.

Points to consider

Authoring requires SQL and editing files, so it is not a tool for business users building their own content.

The output is also not interactive in the way a dashboard is. Where readers need to slice data themselves, this is the wrong shape and a business intelligence tool is appropriate.

There is a build step, which means a report reflects the data as of the last build. How often that happens is a decision to make deliberately.

Getting started

The documentation covers creating a project, connecting a data source, writing a page with a query and a chart component, and building and deploying the site. Producing one page with a single query and chart demonstrates the whole model.

Key features of Evidence

Capabilities described in the official documentation.

Pages written in Markdown

A report page is a text file mixing written explanation, SQL queries and components that render results.

Queries embedded in the page

SQL sits in the page that uses it, so the query behind a chart is visible next to the chart itself.

Components for charts and tables

Results are displayed by placing a component in the page and pointing it at a named query.

Output as a site

Building the project produces a website, which can be published in the same way as any other static site.

Advantages of Evidence

Factual advantages that follow from the features above.

Reports are reviewable as code

Because pages are text files, a change to a report goes through branching and review like application code.

Explanation sits with the figures

Written narrative and charts occupy the same page, so a reader gets the reasoning alongside the numbers.

The query is never hidden

Since SQL lives in the page, anyone can see exactly how a displayed figure was produced.

Publishing is ordinary web hosting

Output is a site, so it is served the same way any other site is rather than requiring a reporting platform.

Common use cases for Evidence

Situations the official documentation describes this tool as being used for.

Business operations

A recurring written report

A monthly review is a page combining commentary with charts, rebuilt from current data each time.

Analytics

Documenting an analysis

The narrative, the queries and the charts stay together so the analysis can be followed and reproduced.

Platform engineering

Reporting managed through Git

Every change to a report is a commit, so history and review apply to reporting as they do to code.

Cross industry

Publishing figures to a wide audience

The generated site is served to readers without a licence being needed for each of them.

Official website

Everything on this page is based on the official documentation for Evidence. You can read the source here.

Evidence official documentation

Frequently asked questions about Evidence

Answers taken from the official documentation for this tool.

Not really. It produces pages that read as documents, mixing written explanation with charts, rather than interactive dashboards. Where the requirement is exploration, a business intelligence tool is a better fit.

Building the project produces a site, which is then hosted like any other website. There is no reporting server to run and no per reader licence involved in serving it.

Inside the page that uses it. A query is written in the Markdown file, given a name, and components reference that name. The result is that a chart and the query producing it are in the same place.

Somebody comfortable with SQL and with editing text files. It is aimed at analysts and engineers rather than at business users building their own content.