Skip to content

Commit

Permalink
Merge pull request #2978 from evidence-dev/strip-trailing-slashes
Browse files Browse the repository at this point in the history
Docs: strip trailing slashes
  • Loading branch information
archiewood authored Jan 7, 2025
2 parents bf8d7cc + 5eeb28e commit 3ac42c3
Show file tree
Hide file tree
Showing 34 changed files with 77 additions and 77 deletions.
26 changes: 13 additions & 13 deletions sites/docs/pages/build-your-first-app/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: A 10 minute guide to building your first Evidence app.
---


This is a guided tutorial to help you build your first Evidence app. If you'd prefer to learn how Evidence works, start with the [Syntax](/core-concepts/syntax/).
This is a guided tutorial to help you build your first Evidence app. If you'd prefer to learn how Evidence works, start with the [Syntax](/core-concepts/syntax).

<Alert>

Expand Down Expand Up @@ -53,7 +53,7 @@ npm run dev

<br>

If you chose a different setup during [Install Evidence](/install-evidence/#other-options), use the command that matches your setup.
If you chose a different setup during [Install Evidence](/install-evidence#other-options), use the command that matches your setup.

Your browser should open automatically. If it doesn't, open your browser and navigate to `localhost:3000` in the address bar. You should see your Evidence app:

Expand Down Expand Up @@ -83,7 +83,7 @@ Make some more changes to the page. You'll see them reflected "live" in the brow

This is called **hot reloading** (HMR), and it allows you to see your changes in real-time as you are building your page.

Evidence pages are `.md` files, and are written in a popular language called Markdown. You can learn more about Markdown [here](https://docs.evidence.dev/reference/markdown/).
Evidence pages are `.md` files, and are written in a popular language called Markdown. You can learn more about Markdown [here](/reference/markdown).

You can also insert HTML directly into your page if you need more control.

Expand Down Expand Up @@ -118,7 +118,7 @@ Now that you know how to create and edit pages, let's move on to working with da

Navigate to `localhost:3000/settings` in your browser.

Here you'll find our demo dataset, `needful_things`. It is a [DuckDB](https://duckdb.org/) database, which is one of many databases that Evidence supports.
Here you'll find our demo dataset, `needful_things`. It is a [DuckDB](https://duckdb.org) database, which is one of many databases that Evidence supports.

![The Evidence settings page.](/img/getting-started/duck_db.png)

Expand Down Expand Up @@ -161,7 +161,7 @@ Once you have configured source queries, you need to **run sources** to actually

If your dev server is running, sources will run automatically if you make changes to your queries.

If your data source itself has changed, or if you are building pages [for deployment](/deployment/overview/), you may need to run sources manually from the Command Line:
If your data source itself has changed, or if you are building pages [for deployment](/deployment/overview), you may need to run sources manually from the Command Line:

```bash
npm run sources
Expand All @@ -176,7 +176,7 @@ Data from various sources and formats (i.e. Snowflake, a Postgres database, and
<br/>


Learn more at at Core Concepts &gt; [Data Sources](/core-concepts/data-sources/).
Learn more at at Core Concepts &gt; [Data Sources](/core-concepts/data-sources).
</Alert>

### 7. Set up a Markdown Query
Expand Down Expand Up @@ -217,15 +217,15 @@ A **source query** is run directly against your data source, and must be written
A **Markdown query** is written in the DuckDB dialect, and is run against the data cache. Markdown queries run with every page load, and their outputs are directly accessible by components within your pages.
<br>

To learn more about Markdown queries, including how to reuse them across pages, take a look at Core Concepts &gt; [Markdown Queries](/core-concepts/queries/).
To learn more about Markdown queries, including how to reuse them across pages, take a look at Core Concepts &gt; [Markdown Queries](/core-concepts/queries).

</Alert>

## Adding components

### 8. Create a Data Table

One simple way to display data is with a [Data Table](/components/data/data-table/). Add a `DataTable` component that uses `my_query_summary` as its data source:
One simple way to display data is with a [Data Table](/components/data/data-table). Add a `DataTable` component that uses `my_query_summary` as its data source:

**new-page.md**
````markdown
Expand Down Expand Up @@ -305,7 +305,7 @@ This will display:



A Data Table is a built-in **component** of Evidence, and there are many more. To see a full list of components, take a look at the left-hand sidebar, or go to [All Components](/components/all-components/).
A Data Table is a built-in **component** of Evidence, and there are many more. To see a full list of components, take a look at the left-hand sidebar, or go to [All Components](/components/all-components).

### 9. Create a Bar Chart

Expand Down Expand Up @@ -358,7 +358,7 @@ Select Source Type: **CSV**, and give your source a name. Hit Confirm:

![Add new source](/img/getting-started/add_new_source2.png)

You can read about various configuration options for CSV files [here](https://docs.evidence.dev/core-concepts/data-sources/#csv-files). For now, leave this blank, and hit **Confirm Changes**:
You can read about various configuration options for CSV files [here](/core-concepts/data-sources#csv-files). For now, leave this blank, and hit **Confirm Changes**:

![Add new source](/img/getting-started/add_new_source_confirm_changes.png)

Expand Down Expand Up @@ -403,9 +403,9 @@ That's it! You now know the basics of setting up data sources, writing queries,

## Next steps

- Explore other components: [All Components](/components/all-components/)
- Learn how to deploy your Evidence app: [Deployment](/deployment/overview/)
- Learn more about writing and organizing Markdown queries: [SQL Queries](/core-concepts/queries/)
- Explore other components: [All Components](/components/all-components)
- Learn how to deploy your Evidence app: [Deployment](/deployment/overview)
- Learn more about writing and organizing Markdown queries: [SQL Queries](/core-concepts/queries)

### Help and support
If you need help, or have corrections and suggestions for this tutorial, please join the [Evidence Slack community](https://slack.evidence.dev).
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/area-chart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,14 +532,14 @@ queries:

<PropListing
name="echartsOptions"
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
required=false
options="{`{{exampleOption:'exampleValue'}}`}"
defaultValue="-"
/>
<PropListing
name="seriesOptions"
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
required=false
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
defaultValue="-"
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/bar-chart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -740,12 +740,12 @@ queries:

<PropListing
name=echartsOptions
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name=seriesOptions
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/box-plot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,12 +394,12 @@ from ${sales_distribution_by_channel}

<PropListing
name="echartsOptions"
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name="seriesOptions"
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/bubble-chart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,12 +384,12 @@ queries:

<PropListing
name="echartsOptions"
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name="seriesOptions"
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/calendar-heatmap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,12 +237,12 @@ queries:

<PropListing
name="echartsOptions"
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name="seriesOptions"
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/funnel-chart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,12 +217,12 @@ select * from (

<PropListing
name=echartsOptions
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name=seriesOptions
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/heatmap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,12 +427,12 @@ order by state asc, item asc

<PropListing
name=echartsOptions
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name=seriesOptions
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
6 changes: 3 additions & 3 deletions sites/docs/pages/components/charts/histogram/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Minimum height of the chart area (excl. header and footer) in pixels. Adjusting
defaultValue="true"
/>

Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on renderers](https://echarts.apache.org/handbook/en/best-practices/canvas-vs-svg/).
Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on renderers](https://echarts.apache.org/handbook/en/best-practices/canvas-vs-svg).

</PropListing>

Expand All @@ -303,15 +303,15 @@ Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on
options="{`{{exampleOption:'exampleValue'}}`}"
>
Custom Echarts options to override the default options. See [reference page](/components/charts/echarts-options/) for available options.
Custom Echarts options to override the default options. See [reference page](/components/charts/echarts-options) for available options.

</PropListing>
<PropListing
name="seriesOptions"
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
>
Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See [reference page](/components/charts/echarts-options/) for available options.
Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See [reference page](/components/charts/echarts-options) for available options.

</PropListing>
<PropListing
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/pages/components/charts/line-chart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -686,12 +686,12 @@ group by all

<PropListing
name=echartsOptions
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options. See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleOption:'exampleValue'}}`}"
/>
<PropListing
name=seriesOptions
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options/' class=markdown>reference page</a> for available options."
description="Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See <a href='/components/charts/echarts-options' class=markdown>reference page</a> for available options."
options="{`{{exampleSeriesOption:'exampleValue'}}`}"
/>
<PropListing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ Apply a specific color to each series in your chart. Unspecified series will rec
defaultValue="true"
/>

Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on renderers](https://echarts.apache.org/handbook/en/best-practices/canvas-vs-svg/).
Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on renderers](https://echarts.apache.org/handbook/en/best-practices/canvas-vs-svg).

</PropListing>

Expand Down
2 changes: 1 addition & 1 deletion sites/docs/pages/components/charts/sankey-diagram/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ Minimum height of the chart area (excl. header and footer) in pixels. Adjusting
options="{`{{exampleOption:'exampleValue'}}`}"
>
Custom Echarts options to override the default options. See [reference page](/components/charts/echarts-options/) for available options.
Custom Echarts options to override the default options. See [reference page](/components/charts/echarts-options) for available options.

</PropListing>
<PropListing
Expand Down
Loading

0 comments on commit 3ac42c3

Please sign in to comment.