This package contains plugin needed to embed SQL Frames into Docusaurus. It is accompanied with another package called @sqlframes/docusaurus-components that provides the docusaurus components functionality to embed SQL Frames into Docusaurus.

Usage within Docusaurus

In the docusaurus.config.json file, add the following

  plugins: [
    '@sqlframes/docusaurus-plugin'
  ],

In addition customFields fields of the config JSON node should be configured. Sample code below

  customFields: {
    sqlframes: {
      version: 'latest', // or any valid version of @sqlframes/repl-app such as 0.12.1
      license: {"data":{"domain":"localhost","expiry_date":"2022/09/30"},"signature":"CC1gnQL48/Vlt/RoPYTfKA5KSA191foKpl5mlYLHtj53kpZTIj6pnr4+KYiRmuetkx12HWHNzcBMLsvmt8dv6A=="} // this is the SQL Frames license key
    }
  },