diff --git a/site/content/docs/components.md b/site/content/docs/components.md new file mode 100644 index 00000000..cb761af4 --- /dev/null +++ b/site/content/docs/components.md @@ -0,0 +1,9 @@ +# Components + +PortalJS comes with a library of components that provides essential pieces for your data portal. The best way to explore the components is to look at our [Storybook](https://storybook.portaljs.org/) that contains all the details on how to use them. Below is a quick summary of existing components today: + +- `` A searchable catalog that will index a list of datasets and allow for contextual searching + filters. +- `` A simple component that allows the creation of an opinionated line chart without the need to go deep into charting standards +- `` A wrapper around the [Vega specification](https://vega.github.io/vega/) that allows you to build pretty much any kind of chart imaginable +- `` A wrapper around the [Vega Lite specification](https://vega.github.io/vega-lite/) which allows for a more concise grammar than Vega around the building of charts. +- `` is an easy-to-use table component with built-in pagination, search, and sorting. diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md index 33e4f433..9367ba4a 100644 --- a/site/content/docs/deploying-your-portaljs-app.md +++ b/site/content/docs/deploying-your-portaljs-app.md @@ -53,4 +53,3 @@ https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#d Note that you don't have to change anything - just follow the steps, choosing the repository you created. - diff --git a/site/content/docs/sidebar.json b/site/content/docs/sidebar.json index c2649c50..1a1561ec 100644 --- a/site/content/docs/sidebar.json +++ b/site/content/docs/sidebar.json @@ -24,6 +24,10 @@ } ] }, + { + "name": "Components", + "href": "/docs/components" + }, { "name": "Examples", "children": [