diff --git a/site/content/docs/components-api.md b/site/content/docs/components-api.md new file mode 100644 index 00000000..0d75237a --- /dev/null +++ b/site/content/docs/components-api.md @@ -0,0 +1,13 @@ +# Components API + +You now have a basic data catalog running, the next step would be to dig into the components library. PortalJS supports the following components by default: + +- `` 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. + +For more details on those please refer to our [Storybook Documentation](https://storybook.portaljs.org/), which contains all the details on how to use them. + + diff --git a/site/content/docs/deploying-your-portaljs-app.md b/site/content/docs/deploying-your-portaljs-app.md index 33e4f433..26a39bb3 100644 --- a/site/content/docs/deploying-your-portaljs-app.md +++ b/site/content/docs/deploying-your-portaljs-app.md @@ -52,5 +52,5 @@ 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..3e7f1941 100644 --- a/site/content/docs/sidebar.json +++ b/site/content/docs/sidebar.json @@ -21,6 +21,10 @@ { "name": "Deploying your PortalJS app", "href": "/docs/deploying-your-portaljs-app" + }, + { + "name": "Components API", + "href": "/docs/components-api" } ] },