配置 jupyter_lite_config.json、jupyter-lite.json 和 overrides.json#

JupyterLite 可以通过一组众所周知的文件进行配置

  • jupyter_lite_config.json - 用于构建时配置，通常在运行 jupyter lite build 时

  • jupyter-lite.json - 用于运行时配置，通常在加载页面时

  • overrides.json - 用于在浏览器中打开 JupyterLite 时，在运行时覆盖插件和扩展设置

jupyter_lite_config.json#

jupyter_lite_config.json 文件用于配置 JupyterLite 的构建时配置。它是一个 JSON 文件，可以在顶级包含多个键，用于配置主构建过程，也可以配置额外的 CLI 附加组件。

它通常用于配置常见的构建设置，例如输出目录或内容文件夹。

以下是一个 jupyter_lite_config.json 的示例，用于配置 contents 和 outputDir

{
  "LiteBuildConfig": {
    "contents": ["notebooks"],
    "output_dir": "dist"
  }
}

您可以参考一些指南以了解更多配置选项

注意

查看 CLI 参考 以获取更完整的构建时配置选项列表

jupyter-lite.json#

jupyter-lite.json 文件用于配置 JupyterLite 的运行时配置。

例如，它可用于配置 JupyterLite 应用程序的 appName 或 disabledExtensions 列表。

以下是一个 jupyter-lite.json 的示例

{
  "jupyter-lite-schema-version": 0,
  "jupyter-config-data": {
    "appName": "My JupyterLite App",
    "disabledExtensions": ["@jupyterlab/application-extension:logo"]
  }
}

您可以参考一些指南以了解更多配置选项

注意

JupyterLite 提供了更多提供运行时配置的方式。有关更多详细信息，请查看 运行时配置文件。

注意

查看 Schema 以获取可用配置选项的完整列表。

overrides.json#

overrides.json 文件用于覆盖 JupyterLite 的插件和扩展设置。

例如，当用户启动 JupyterLite 时，它可用于覆盖默认主题。文件的内容将是

{
  "@jupyterlab/apputils-extension:themes": {
    "theme": "JupyterLab Dark"
  }
}

它可用于覆盖 JupyterLite 主应用程序中的其他插件和扩展，以及第三方扩展。

您可以参考以下指南以查看更多示例