About the Demo#

This documentation site contains the JupyterLite Demo (the Try buttons on the top of the screen) and uses a number of techniques described on this page.

Demo Configuration#

The following generated configuration powers the Demo, and is generated prior to building the docs site, copied in during the build, and fetched by browsers from /_static/jupyter-lite.json.

{
  "jupyter-config-data": {
    "appName": "JupyterLite Examples",
    "appUrl": "./lab",
    "appVersion": "0.1.0-beta.14",
    "baseUrl": "./",
    "collaborative": true,
    "defaultKernelName": "python",
    "exposeAppInBrowser": true,
    "faviconUrl": "./lab/favicon.ico",
    "federated_extensions": [
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.17b005fe12a237b5ee9f.js",
        "name": "@agoose77/jupyterlab-markup"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.1116b848a6f7126bf3e9.js",
        "name": "@jupyter-widgets/jupyterlab-manager"
      },
      {
        "liteExtension": false,
        "load": "static/remoteEntry.cdf08c015a8192358158.js",
        "mimeExtension": "./mimeExtension",
        "name": "@jupyterlab/fasta-extension",
        "style": "./style"
      },
      {
        "liteExtension": false,
        "load": "static/remoteEntry.b75c764d727b50009261.js",
        "mimeExtension": "./mimeExtension",
        "name": "@jupyterlab/geojson-extension",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.e0263a028853908ae4bb.js",
        "name": "@jupyterlab/github",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": true,
        "load": "static/remoteEntry.4ba93726087006d2f61b.js",
        "name": "@jupyterlite/p5-kernel-extension",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.8dcc730aedc487734a23.js",
        "name": "@jupyterlite/webrtc-docprovider",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.c7d5ca84bbdfef35f278.js",
        "name": "@telamonian/theme-darcula"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.145e469029155b53b350.js",
        "name": "@timkpaine/jupyterlab_miami_nights"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.99c828c2ee313756f7dc.js",
        "name": "bqplot"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.9693baf6fc7fc4c880d2.js",
        "name": "ipycanvas"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.03390b18ed36b245b514.js",
        "name": "jupyter-cytoscape"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.826666d2e0fe36d6609e.js",
        "name": "jupyter-leaflet"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.cec326f8f2959bfbc636.js",
        "name": "jupyter-matplotlib"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.8a3514e7c1c3c4a80f2e.js",
        "name": "jupyter-vue"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.0b6a37985538f1f2120b.js",
        "name": "jupyter-vuetify"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.8f896d6ad92823566c46.js",
        "name": "jupyterlab-drawio",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.108d6f7322c28e6c45f9.js",
        "name": "jupyterlab-kernelspy",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.b65dd4fef9fa6e2779f9.js",
        "name": "jupyterlab-myst",
        "style": "./style"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.249e02ea9427f8cca2ad.js",
        "mimeExtension": "./mimeExtension",
        "name": "jupyterlab-plotly"
      },
      {
        "extension": "./extension",
        "liteExtension": false,
        "load": "static/remoteEntry.5a1869d4304cb9223cfc.js",
        "name": "jupyterlab-tour",
        "style": "./style"
      }
    ],
    "fileTypes": {
      "css": {
        "extensions": [
          ".css"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/css"
        ],
        "name": "css"
      },
      "csv": {
        "extensions": [
          ".csv"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/csv"
        ],
        "name": "csv"
      },
      "fasta": {
        "extensions": [
          ".fasta"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/plain"
        ],
        "name": "fasta"
      },
      "geojson": {
        "extensions": [
          ".geojson"
        ],
        "fileFormat": "json",
        "mimeTypes": [
          "application/geo+json"
        ],
        "name": "geojson"
      },
      "gzip": {
        "extensions": [
          ".tgz",
          ".gz",
          ".gzip"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "application/gzip"
        ],
        "name": "gzip"
      },
      "html": {
        "extensions": [
          ".html"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/html"
        ],
        "name": "html"
      },
      "ical": {
        "extensions": [
          ".ical",
          ".ics",
          ".ifb",
          ".icalendar"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/calendar"
        ],
        "name": "ical"
      },
      "ico": {
        "extensions": [
          ".ico"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "image/x-icon"
        ],
        "name": "ico"
      },
      "ipynb": {
        "extensions": [
          ".ipynb"
        ],
        "fileFormat": "json",
        "mimeTypes": [
          "application/x-ipynb+json"
        ],
        "name": "ipynb"
      },
      "jpeg": {
        "extensions": [
          ".jpeg",
          ".jpg"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "image/jpeg"
        ],
        "name": "jpeg"
      },
      "js": {
        "extensions": [
          ".js",
          ".mjs"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "application/javascript"
        ],
        "name": "js"
      },
      "jsmap": {
        "extensions": [
          ".map"
        ],
        "fileFormat": "json",
        "mimeTypes": [
          "application/json"
        ],
        "name": "jsmap"
      },
      "json": {
        "extensions": [
          ".json"
        ],
        "fileFormat": "json",
        "mimeTypes": [
          "application/json"
        ],
        "name": "json"
      },
      "manifest": {
        "extensions": [
          ".manifest"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/cache-manifest"
        ],
        "name": "manifest"
      },
      "md": {
        "extensions": [
          ".md",
          ".markdown"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/markdown"
        ],
        "name": "md"
      },
      "pdf": {
        "extensions": [
          ".pdf"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "application/pdf"
        ],
        "name": "pdf"
      },
      "plain": {
        "extensions": [
          ".txt"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/plain"
        ],
        "name": "plain"
      },
      "png": {
        "extensions": [
          ".png"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "image/png"
        ],
        "name": "png"
      },
      "py": {
        "extensions": [
          ".py"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/x-python",
          "application/x-python-code"
        ],
        "name": "py"
      },
      "svg": {
        "extensions": [
          ".svg"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "image/svg+xml"
        ],
        "name": "svg"
      },
      "toml": {
        "extensions": [
          ".toml"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "application/toml"
        ],
        "name": "toml"
      },
      "vue": {
        "extensions": [
          ".vue"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "text/plain"
        ],
        "name": "vue"
      },
      "wasm": {
        "extensions": [
          ".wasm"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "application/wasm"
        ],
        "name": "wasm"
      },
      "wheel": {
        "extensions": [
          ".whl"
        ],
        "fileFormat": "base64",
        "mimeTypes": [
          "octet/stream",
          "application/x-wheel+zip"
        ],
        "name": "wheel"
      },
      "xml": {
        "extensions": [
          ".xml"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "application/xml"
        ],
        "name": "xml"
      },
      "yaml": {
        "extensions": [
          ".yaml",
          ".yml"
        ],
        "fileFormat": "text",
        "mimeTypes": [
          "application/x-yaml"
        ],
        "name": "yaml"
      }
    },
    "fullLabextensionsUrl": "./extensions",
    "fullMathjaxUrl": "./static/jupyter_server_mathjax/MathJax.js",
    "fullStaticUrl": "./build",
    "licensesUrl": "./lab/api/licenses",
    "litePluginSettings": {
      "@jupyterlite/pyolite-kernel-extension:kernel": {
        "pipliteUrls": [
          "./pypi/all.json?sha256=c33d004d3d5155e27a2baa531fc693380f7449886df632a534f7fe5f355ddd84"
        ]
      }
    },
    "mathjaxConfig": "TeX-AMS-MML_HTMLorMML-full,Safe",
    "settingsOverrides": {
      "@jupyterlab/github:drive": {
        "defaultRepo": "jupyterlite/jupyterlite"
      },
      "jupyterlab-tour:user-tours": {
        "tours": [
          {
            "id": "jupyter-lite",
            "label": "Welcome to JupyterLite",
            "options": {},
            "steps": [
              {
                "content": "This is JupyterLite",
                "target": "#jp-MainLogo"
              }
            ]
          }
        ]
      }
    }
  },
  "jupyter-lite-schema-version": 0
}

Demo Extension Notes#

The federated_extensions above are copied from the documentation environment prior to building this site with Sphinx, and are meant to exercise different kinds of extensions, including themes, MIME renderers, Widgets, and an shared document provider for RTC.

The demo disables autodetection of environment extensions with ignore_sys_prefix, as the outer development environment includes a number of extensions with features that don’t work.