Evidence

<div id="top" align="center">

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="./sites/docs/static/img/wordmark-dark.svg">
  <img alt="Evidence Logo" src="./sites/docs/static/img/wordmark-light.svg">
</picture>

Business Intelligence as Code: Generate reports using SQL and markdown

<!-- Testing publishing flow -->

### [Docs](https://docs.evidence.dev) | [Examples](https://evidence.dev/examples) | [Slack](https://slack.evidence.dev)

![GitHub Repo stars](https://img.shields.io/github/stars/evidence-dev/evidence?style=social)
![NPM](https://img.shields.io/npm/l/%40evidence-dev%2Fevidence)
![npm](https://img.shields.io/npm/v/@evidence-dev/evidence?logo=npm)
![Release](https://img.shields.io/github/actions/workflow/status/evidence-dev/evidence/release.yml?logo=npm)
[![Join Slack](https://img.shields.io/badge/slack-join-blue?logo=slack&amp)](https://slack.evidence.dev)

</div>

> [!TIP]
> **Try [Evidence Studio](https://evidence.studio)**: The new, faster way to build data products with SQL, markdown and AI.

# How It Works

Evidence is an open-source, code-based alternative to drag-and-drop business intelligence tools.

![how-it-works](sites/docs/static/img/how-it-works.png)

Evidence generates a website from markdown files:

- **SQL statements** inside markdown files run queries against your data sources
- **Charts and components** are rendered using these query results
- **Templated pages** generate many pages from a single markdown template
- **Loops** and **If / Else** statements allow control of what is displayed to users

# Install

1. Download the [Evidence VSCode Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode)
2. Open the Command Palette (F1) and enter `Evidence: New Evidence Project`
3. Click the Start Evidence button in the bottom status bar

See docs for [other install options](https://docs.evidence.dev/getting-started/install-evidence) (CLI, Docker, etc)

# Publish

- [Self-hosted](https://docs.evidence.dev/deployment/overview/#self-host) options include Netlify, Vercel, your own infra, and other static site hosting platforms.

# Join the Evidence Community

Join our [Slack channel](https://slack.evidence.dev) to get involved in the community's discussion, share what you're working on, or ask for help.

Follow us on [Twitter](https://twitter.com/evidence_dev) to receive the latest updates on Evidence.

# Contributing

If you are interested in contributing, please join us on our [slack channel](https://slack.evidence.dev), open an [issue](https://github.com/evidence-dev/evidence/issues/new), or contribute a pull request.

# License

Evidence is licensed under the MIT license. See the [LICENSE](LICENSE.md) file for licensing information.