Skip to main content
Internal notes
TitleHandling large tables
Preview Link... -large-tables

Handling large tables

  1. Place tables you want to be filterable under static/tables/*.md

A script running in the background automatically generates a JSON equivalent if you place tables here.

  1. Inside your Markdown source file, include the table like so
<FilterTable tableSourceFileName="<table-name>" />
Automatic filepath completion

You don't have to put in the relative filepath to the generated table JSON file. Just put in the name as shown in the example here without the file extension.

Known limitations​

  • To support i18n, we'll have to migrate from static/tables to docs/tables or have the script generate a second json file (<file-name>_DE.json) (or put them under /tables/translated/DE/<table-name>.json). Currently, translation isn't actively supported for large tables.

Coming improvments​

  • Tables will be stored as regular Markdown files under docs/tables
  • Specifying a table as filterable is as easy as typing TABLE::<table-name>:filterable in Markdown source files. This is enabled via a custom MDX plugin we'll write
  • Similarly, if wanted we can have TABLE::<table-name> to quickly include a table without filtering