# Evidence Docs - [What is Evidence?](https://docs.evidence.dev/index.md): Evidence is a powerful framework for building and publishing data products using SQL, markdown, and AI. - [Quickstart](https://docs.evidence.dev/quickstart.md): Start building reports in under 5 minutes - [Migration Guide](https://docs.evidence.dev/migration-guide.md): Migrate a legacy Evidence project to Evidence Studio - [Editing](https://docs.evidence.dev/editing.md): The Evidence Editor is the core of Evidence Studio, allowing you to create and edit reports in markdown and SQL. - [Publishing](https://docs.evidence.dev/publishing.md): Publish your reports on Evidence Studio, or self host your reports to share them with your team. - [Markdown](https://docs.evidence.dev/core-concepts/markdown.md): Evidence pages are written in markdown, with additional syntax for adding SQL queries and charts. - [Components](https://docs.evidence.dev/core-concepts/components.md): Components are used to create visual elements such as charts, tables and UI elements. - [Models](https://docs.evidence.dev/core-concepts/models.md): Transform and combine your data with SQL models that run automatically in the background. - [Metrics](https://docs.evidence.dev/core-concepts/metrics.md): Define reusable, governed metrics once and reference them by name from any data component. - [Value Formatting](https://docs.evidence.dev/core-concepts/value-formatting.md): Format values in components. - [Variables](https://docs.evidence.dev/core-concepts/variables.md): Create reusable values for use in markdown and SQL. - [Partials](https://docs.evidence.dev/core-concepts/partials.md): Partials allow you to define reusable sections of content that can be included across multiple pages in your project. - [Custom Components](https://docs.evidence.dev/core-concepts/custom-components.md): Build your own Markdoc tags from markdown files — each component declares typed attributes in frontmatter and can be called from any page like a built-in. - [Version Control](https://docs.evidence.dev/features/version-control.md): Learn how to manage your Evidence projects using BI as code with Git. - [Project Settings](https://docs.evidence.dev/features/project-settings.md): Configure project-wide settings and theme with version-controlled evidence.config.yaml and theme.yaml files. - [Page Settings](https://docs.evidence.dev/features/page-settings.md): Set a page title, layout, theme, and other per-page settings using YAML frontmatter at the top of a page. - [Themes](https://docs.evidence.dev/features/themes.md): Customize colors and layout to match your brand with version-controlled theme.yaml and page settings. - [Layouts](https://docs.evidence.dev/features/layouts.md): The Row and Stack components help you create an interactive data visualization dashboard in Evidence markdown. - [SQL Files](https://docs.evidence.dev/features/sql-files.md): Create reusable SQL queries as standalone files that can be referenced by components and inline queries. - [Page Level Access Control](https://docs.evidence.dev/features/page-level-access-control.md): Control who can view your published reports and pages with a version-controlled access.yaml file. - [Row Level Security](https://docs.evidence.dev/features/row-level-security.md): Control which tables and rows each user can see with table access rules, row level security, and user variables. - [Evidence Agent](https://docs.evidence.dev/features/evidence-agent.md): Shape the Evidence Agent with version-controlled context and skills in the agent/ directory. - [Translations](https://docs.evidence.dev/features/translations.md): Create multi-language versions of your pages with a version-controlled translations.yaml file at the project root. - [Embedded Analytics](https://docs.evidence.dev/features/embedded-analytics.md): Deliver secure, personalized customer facing dashboards inside your own product - [Scheduled Reports](https://docs.evidence.dev/features/scheduled-reports.md): Deliver published reports by email or Slack on a recurring schedule, or send one-off copies on demand. - [Overview](https://docs.evidence.dev/mcp/overview.md): Connect AI clients to Evidence with the Model Context Protocol. - [Studio MCP](https://docs.evidence.dev/mcp/studio.md): Connect AI assistants to your live Evidence workspace — query data and read published reports. - [Docs MCP](https://docs.evidence.dev/mcp/docs.md): Use AI tools to build Evidence reports with the Evidence Docs MCP server. - [CLI](https://docs.evidence.dev/cli/index.md): Develop Evidence Studio projects locally or with the agent of your choice. - [Connect your CLI to your data](https://docs.evidence.dev/cli/connections.md): With an Evidence Studio account, run evidence login. Use connection.yaml only without an account, with different credentials, or offline. - [Commands](https://docs.evidence.dev/cli/commands.md): Reference for all Evidence CLI commands. - [Self Host](https://docs.evidence.dev/self-host/index.md): Host your Evidence project on platforms including Vercel, Render, Fly.io, and Railway. - [Authentication & SSO](https://docs.evidence.dev/self-host/authentication.md): Integrate a self-hosted Evidence deployment with your identity provider by fronting it with an authenticating reverse proxy. - [Self Host on Vercel](https://docs.evidence.dev/self-host/vercel.md): Self-host Evidence on Vercel Container Images with a Dockerfile. - [Self Host on Render](https://docs.evidence.dev/self-host/render.md): Self-host Evidence on Render as a Docker web service. - [Self Host on Fly.io](https://docs.evidence.dev/self-host/fly.md): Self-host Evidence on Fly.io from the dashboard or the fly CLI. - [Self Host on Railway](https://docs.evidence.dev/self-host/railway.md): Self-host Evidence on Railway from a GitHub repo. - [Snowflake](https://docs.evidence.dev/direct-connectors/snowflake.md): Query your Snowflake warehouse directly from Evidence without syncing data. - [Microsoft Fabric](https://docs.evidence.dev/direct-connectors/fabric.md): Query your Microsoft Fabric Warehouse directly from Evidence without syncing data. - [SQL Server](https://docs.evidence.dev/direct-connectors/sqlserver.md): Query your SQL Server or Azure SQL database directly from Evidence without syncing data. - [ClickHouse](https://docs.evidence.dev/direct-connectors/clickhouse.md): Query your own ClickHouse instance directly from Evidence without syncing data. - [BigQuery](https://docs.evidence.dev/direct-connectors/bigquery.md): Query your BigQuery datasets directly from Evidence without syncing data. - [Databricks](https://docs.evidence.dev/direct-connectors/databricks.md): Query your own Databricks SQL Warehouse directly from Evidence without syncing data. - [Postgres](https://docs.evidence.dev/direct-connectors/postgres.md): Query your own Postgres database directly from Evidence without syncing data. - [Cube](https://docs.evidence.dev/direct-connectors/cube.md): Query your Cube semantic layer directly from Evidence through its Postgres-wire SQL API. - [Amazon Redshift](https://docs.evidence.dev/direct-connectors/redshift.md): Connect Evidence directly to an Amazon Redshift cluster or Redshift Serverless workgroup. - [MotherDuck](https://docs.evidence.dev/direct-connectors/motherduck.md): Query your MotherDuck (cloud DuckDB) database directly from Evidence without syncing data. - [Evidence Warehouse](https://docs.evidence.dev/evidence-warehouse.md): Evidence's built-in managed warehouse, and the connectors that load data into it. - [Athena](https://docs.evidence.dev/data-sources/athena.md): AWS Athena is a serverless, interactive query service that enables analysis of data directly in Amazon S3 using standard SQL. Evidence supports connecting to Athena as a data source for querying data. - [MotherDuck](https://docs.evidence.dev/data-sources/motherduck.md): MotherDuck is a cloud-based data platform for running DuckDB. Evidence supports connecting to MotherDuck as a data source. - [Redshift](https://docs.evidence.dev/data-sources/redshift.md): Amazon Redshift is a fully managed, petabyte-scale data warehouse service in the cloud. Evidence supports connecting to Redshift as a data source, allowing you to query data using SQL. The format of the connection string is: `redshift://:@:/?sslmode=require&opti… - [Microsoft Azure Blob Storage](https://docs.evidence.dev/data-sources/abs.md): Connect to Parquet files in Microsoft Azure Blob Storage. - [BackBlaze](https://docs.evidence.dev/data-sources/backblaze.md): Connect to Parquet files in BackBlaze. - [Custom Bucket Provider](https://docs.evidence.dev/data-sources/custom.md): Connect to Parquet files in Custom Bucket Provider. - [Google Cloud Storage (GCS)](https://docs.evidence.dev/data-sources/gcs.md): Connect to Parquet files in Google Cloud Storage (GCS). - [Cloudflare R2](https://docs.evidence.dev/data-sources/r2.md): Connect to Parquet files in Cloudflare R2. - [AWS (S3)](https://docs.evidence.dev/data-sources/s3.md): Connect to Parquet files in AWS (S3). - [Delta Lake](https://docs.evidence.dev/data-sources/deltalake_s3.md) - [Iceberg](https://docs.evidence.dev/data-sources/iceberg.md): Apache Iceberg is a high performance open-source format for large analytic tables. Evidence supports connecting to Iceberg as a data source for reading data files. - [Flat Files](https://docs.evidence.dev/data-sources/file.md): Evidence supports connecting to flat files as a data sources, including CSV, JSONL, and Parquet files. - [Value](https://docs.evidence.dev/components/value.md): Display a single value from a database query - [Big Value](https://docs.evidence.dev/components/big_value.md): Display a big value with optional comparison, delta, and sparkline - [Delta](https://docs.evidence.dev/components/delta.md): Display an inline delta value with an up/down indicator - [Heat Grid](https://docs.evidence.dev/components/heat_grid.md): Display a grid of color-coded cells based on metric thresholds - [Progress Bars](https://docs.evidence.dev/components/progress_bars.md): Display progress bars showing a numerator/denominator ratio per category - [Table](https://docs.evidence.dev/components/table.md): Display a table of data with dimensions, pivots, and measures - [Dimension](https://docs.evidence.dev/components/dimension.md): Add a dimension to a table, including date filtering, date grains, formatting, and more - [Measure](https://docs.evidence.dev/components/measure.md): Add a measure to a table, including comparisons, sparklines, and more - [Pivot](https://docs.evidence.dev/components/pivot.md): Add a pivot to a table, including date filtering, date grains, formatting, and more - [Area Chart](https://docs.evidence.dev/components/area_chart.md): Display an area chart - [Bar Chart](https://docs.evidence.dev/components/bar_chart.md): Display a bar chart - [Bubble Chart](https://docs.evidence.dev/components/bubble_chart.md): Display a bubble chart - [Calendar Heatmap](https://docs.evidence.dev/components/calendar_heatmap.md): Display a calendar heatmap visualization - [Candlestick](https://docs.evidence.dev/components/candlestick.md): Display a candlestick chart for OHLC (Open, High, Low, Close) financial data visualization - [Chord Chart](https://docs.evidence.dev/components/chord_chart.md): Display a chord diagram showing flows between nodes around a circle - [Combo Chart](https://docs.evidence.dev/components/combo_chart.md): Display a chart with a combination of multiple series types. Accepts area, bar, bubble, line, and scatter children series. - [Custom Echart](https://docs.evidence.dev/components/custom_echart.md): Render any Apache ECharts chart type using a raw ECharts config in the tag body. An escape hatch for charts the built-in components cannot express. - [Funnel Chart](https://docs.evidence.dev/components/funnel_chart.md): Display a funnel chart showing conversion rates through stages - [Heatmap](https://docs.evidence.dev/components/heatmap.md): Display a heatmap chart with color-coded cells - [Histogram](https://docs.evidence.dev/components/histogram.md): Display a histogram chart showing the distribution of values in a column. - [Horizontal Bar Chart](https://docs.evidence.dev/components/horizontal_bar_chart.md): Display a horizontal bar chart - [Line Chart](https://docs.evidence.dev/components/line_chart.md): Display a line chart - [Pie Chart](https://docs.evidence.dev/components/pie_chart.md): Display a pie chart (donut style by default, use inner_radius="0%" for full pie) - [Polar Chart](https://docs.evidence.dev/components/polar_chart.md): Display a polar chart with bars arranged in a circular pattern - [Radar Chart](https://docs.evidence.dev/components/radar_chart.md): Display a radar chart comparing values across multiple axes - [Sankey Chart](https://docs.evidence.dev/components/sankey_chart.md): Display a Sankey diagram showing flow between nodes - [Scatter Chart](https://docs.evidence.dev/components/scatter_chart.md): Display a scatter chart - [Treemap](https://docs.evidence.dev/components/treemap.md): Display a treemap of nested rectangles sized by value - [Waterfall Chart](https://docs.evidence.dev/components/waterfall_chart.md): Display a waterfall chart: a sequence of increases and decreases that bridges one total to another. - [Area](https://docs.evidence.dev/components/area.md): Add an area series to a [combo_chart](/components/combo_chart) - [Bar](https://docs.evidence.dev/components/bar.md): Add a bar series to a [combo_chart](/components/combo_chart) - [Bubble](https://docs.evidence.dev/components/bubble.md): Add a bubble series to a [combo_chart](/components/combo_chart) - [Line](https://docs.evidence.dev/components/line.md): Add a line series to a [combo_chart](/components/combo_chart) - [Reference Area](https://docs.evidence.dev/components/reference_area.md): Add a reference area inside a chart - [Reference Line](https://docs.evidence.dev/components/reference_line.md): Add a reference line inside a chart - [Reference Point](https://docs.evidence.dev/components/reference_point.md): Add a reference point inside a chart - [Scatter](https://docs.evidence.dev/components/scatter.md): Add a scatter series to a [combo_chart](/components/combo_chart) - [Sparkline](https://docs.evidence.dev/components/sparkline.md): Display a small sparkline chart. To add sparklines to a table, use the measure component with the viz="sparkline" option. - [Custom Map](https://docs.evidence.dev/components/custom_map.md): Write a map in JavaScript with Mapbox GL or MapLibre GL, using your page data. Use it when the built-in map component does not cover what you need. - [Map](https://docs.evidence.dev/components/map.md): Display an interactive map - [Area Layer](https://docs.evidence.dev/components/area_layer.md): Add a choropleth layer to a map - [Heatmap Layer](https://docs.evidence.dev/components/heatmap_layer.md): Add a heatmap layer to a map showing density of lat/lng coordinates - [Point Layer](https://docs.evidence.dev/components/point_layer.md): Add a point layer to a map showing lat/lng coordinates - [Button Group](https://docs.evidence.dev/components/button_group.md): Display a segmented button group with distinct values from a database column to use in filters - [Comparison Selector](https://docs.evidence.dev/components/comparison_selector.md): Display a selector for comparison options to use in SQL query templates - [Benchmark Comparison](https://docs.evidence.dev/components/benchmark_comparison.md): Define a custom benchmark comparison option for a comparison_selector - [Target Comparison](https://docs.evidence.dev/components/target_comparison.md): Define a custom target comparison option for a comparison_selector - [Date Grain Selector](https://docs.evidence.dev/components/date_grain_selector.md): Display a selector for date grain options to use in SQL query templates - [Dropdown](https://docs.evidence.dev/components/dropdown.md): Display a dropdown with distinct values from a database column to use in filters - [Filter Bar](https://docs.evidence.dev/components/filter_bar.md): Renders a floating bar of filters at the top or bottom of your page - [Input Tabs](https://docs.evidence.dev/components/input_tabs.md): Display a tab-style selector with distinct values from a database column to use in filters. Appears full-width and does not group with other filter inputs. - [Option](https://docs.evidence.dev/components/option.md): Add an option to a dropdown or button_group component - [Range Calendar](https://docs.evidence.dev/components/range_calendar.md): Display a date range picker for use in SQL query templates - [Slider](https://docs.evidence.dev/components/slider.md): A numeric slider input that can be used in filters - [Table Filter](https://docs.evidence.dev/components/table_filter.md): A filter component for tables with multiple condition support - [Text Input](https://docs.evidence.dev/components/text_input.md): A text input field that can be used in filters - [Toggle](https://docs.evidence.dev/components/toggle.md): Display a toggle switch that outputs true/false values for use in filters - [Dimension Grid](https://docs.evidence.dev/components/dimension_grid.md): Display an interactive grid of dimension columns with aggregated metrics and bar visualizations for filtering - [Period Selector](https://docs.evidence.dev/components/period_selector.md): Display a selector that steps through complete calendar periods (months, quarters, and so on). Use `id="period"` to place the page’s `workflow.period` selector. - [Html](https://docs.evidence.dev/components/html.md): Build custom, interactive visualizations with HTML and JavaScript — D3, Chart.js, Observable Plot, or any JS library. A fully supported way to create bespoke charts, diagrams, and widgets the built-in components don't cover. - [Accordion](https://docs.evidence.dev/components/accordion.md): An accordion component that organizes content into collapsible sections. - [Accordion Item](https://docs.evidence.dev/components/accordion_item.md): An accordion item that can be expanded or collapsed. - [Accordion Title](https://docs.evidence.dev/components/accordion_title.md): Rich title content for an accordion item. Use this instead of the `title` attribute when the title needs to contain other components (e.g. `big_value`). - [Audio](https://docs.evidence.dev/components/audio.md): Embed an audio player for mp3, wav, and other audio formats - [Callout](https://docs.evidence.dev/components/callout.md): Add a callout box to show a message or highlight a section of text - [Clock](https://docs.evidence.dev/components/clock.md): Display a live clock with running seconds and the current date - [Commentary](https://docs.evidence.dev/components/commentary.md): Allows users to input commentary to be saved with the page - [Details](https://docs.evidence.dev/components/details.md): The details component - [Download](https://docs.evidence.dev/components/download.md): A button to download data as an Excel file, supports up to 500,000 row downloads via the limit attribute. - [Fence](https://docs.evidence.dev/components/fence.md): Display a code block - [File](https://docs.evidence.dev/components/file.md): Attach a downloadable file to a report as a card showing its icon, name, type, and date. Drop or paste a file into the editor to upload it to your organization and insert a file tag automatically. - [Hidden In Print](https://docs.evidence.dev/components/hidden_in_print.md): Hide content when printing or generating PDFs, without otherwise affecting its layout - [Icon](https://docs.evidence.dev/components/icon.md): Display an icon with customizable size and color - [Iframe](https://docs.evidence.dev/components/iframe.md): Embed another URL into your page - [Image](https://docs.evidence.dev/components/image.md): Display an image from a URL or from a data query, or paste an image directly into the editor to upload and insert an image tag automatically. - [Info](https://docs.evidence.dev/components/info.md): Display an info icon with a tooltip showing additional information on hover - [Line Break](https://docs.evidence.dev/components/line_break.md): Adds vertical spacing between content by inserting line breaks - [Link](https://docs.evidence.dev/components/link.md): Link to another page in Evidence or an external location - [Link Button](https://docs.evidence.dev/components/link_button.md): A button that links to a URL - [Logo](https://docs.evidence.dev/components/logo.md): Display a company logo from logo.dev - [Modal](https://docs.evidence.dev/components/modal.md): Modal that shows content when opened. - [Note](https://docs.evidence.dev/components/note.md): The note component - [Only In Print](https://docs.evidence.dev/components/only_in_print.md): Show content only when printing or generating PDFs, without otherwise affecting its layout - [Page Break](https://docs.evidence.dev/components/page_break.md): Start content on a new page when printing or generating PDFs - [Partial](https://docs.evidence.dev/components/partial.md): Use a reusable partial to render a section of content. Create a partial in the page sidebar of your project. - [Print Group](https://docs.evidence.dev/components/print_group.md): Group content together to prevent page breaks, or hide or show content only when printing or generating PDFs - [Row](https://docs.evidence.dev/components/row.md): A flexible layout that places its children next to each other - [Stack](https://docs.evidence.dev/components/stack.md): A flexible layout that stacks its children vertically - [Tab](https://docs.evidence.dev/components/tab.md): An individual tab panel within a tabs component. - [Tabs](https://docs.evidence.dev/components/tabs.md): A tabs component that organizes content into multiple panels. - [If](https://docs.evidence.dev/components/if.md): Conditionally render the contents based on whether rows are returned by the query. - [Else If](https://docs.evidence.dev/components/else_if.md): If prior conditional blocks do not pass, conditionally render the contents based on whether rows are returned by the query. - [Else](https://docs.evidence.dev/components/else.md): If prior conditional blocks do not pass, the contents of the else block are rendered. - [Repeat](https://docs.evidence.dev/components/repeat.md): Repeats the children of this component once for each distinct value of a column - [Designing Reports for PDF](https://docs.evidence.dev/guides/designing-reports-for-pdf.md): Design reports that look right as PDFs. - [Changelog](https://docs.evidence.dev/changelog.md): Track the latest updates and improvements to Evidence ## Optional - [Evidence Studio](https://evidence.studio) - [Community](https://slack.evidence.dev) - [Legacy Docs](https://legacy-docs.evidence.dev) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.