如何创建自定义JupyterLab CSS主题扩展?

时间:2019-01-16 01:23:38

标签: themes jupyter jupyter-lab

我正在寻找一种将自定义CSS应用于Jupyter Lab笔记本的简单方法。我尝试按照文档进行操作,并收到以下错误:

Missing extension module "lib/index.js"

运行jupyter labextension install .

Jupyter Lab依靠Themes来调整笔记本的格式。这似乎是使自定义主题可重用的一种合理方法,但是我花了很多时间弄清楚如何进行和应用我想进行的更改。

按照上面链接的“主题”文档进行操作:

  

要基于JupyterLab Light主题快速创建主题,请遵循   提供指南中的说明,然后运行jlpm run   从存储库根目录创建:主题。选择一个   名称,标题和说明,将在以下位置创建一个新的主题文件夹   当前目录。您可以将该新文件夹移动到以下位置   您的选择,然后开始进行所需的更改。

contributing guide中的步骤使我执行了以下操作:

  1. 使用Fork从GitHub克隆了JupyterLab存储库。
  2. pip install -e .
  3. jlpm install
  4. jlpm run build
  5. jlpm run build:core
  6. jupyter lab build

全部来自克隆存储库的本地目录。这具有安装JupyterLab的最新alpha版本的副作用,这不是我想要的。我需要使用一个稳定的发行版,所以我通过conda卸载了jupyterlab,然后重新安装了它。

然后我使用JupyterLab的0.35.4标记重复上述操作。我只在不太可能的情况下提到这种情况,因为双重安装会将事情搞砸了。

然后,我首先看主题authoring documentation

  1. npm install,运行时不会发生意外
  2. npm run build,它抱怨找不到../application/tsconfig.json,我认为还可以,因为我认为我没有使用任何TypeScript(??)
  3. jupyter labextension install .之所以失败,是因为找不到lib/index.js

我认为这是因为lib/index.js列在"main"下。

如果我唯一的目标是更改style目录中的.css文件,我不确定此配置的哪些部分要更改,什么要保留。

这是我完整的package.json文件:

{
  "name": "FirstTheme",
  "version": "0.19.1",
  "description": "My first Theme",
  "homepage": "https://github.com/jupyterlab/jupyterlab",
  "bugs": {
    "url": "https://github.com/jupyterlab/jupyterlab/issues"
  },
  "license": "BSD-3-Clause",
  "author": "Project Jupyter",
  "files": [
    "lib/*.d.ts",
    "lib/*.js.map",
    "lib/*.js",
    "static/*.css",
    "static/*.ttf",
    "static/*.eot",
    "static/*.woff",
    "static/*.woff2"
  ],
  "main": "lib/index.js",
  "types": "lib/index.d.ts",
  "directories": {
    "lib": "lib/"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/jupyterlab/jupyterlab.git"
  },
  "scripts": {
    "build": "tsc -b",
    "build:src": "tsc -b src",
    "build:webpack": "webpack",
    "clean": "rimraf lib && rimraf static",
    "prepublishOnly": "npm run build",
    "watch": "tsc -b --watch",
    "watch:src": "tsc -b src --watch",
    "watch:webpack": "webpack --watch"
  },
  "dependencies": {
    "@jupyterlab/application": "^0.19.1",
    "@jupyterlab/apputils": "^0.19.1",
    "ajv": "^6.7.0",
    "font-awesome": "~4.7.0"
  },
  "devDependencies": {
    "css-loader": "~0.28.7",
    "mini-css-extract-plugin": "^0.4.0",
    "npm-run-all": "~4.1.1",
    "rimraf": "~2.6.2",
    "svg-url-loader": "~2.3.1",
    "svgo": "~1.0.4",
    "svgo-loader": "~2.1.0",
    "typedoc": "~0.12.0",
    "typescript": "~3.1.1",
    "url-loader": "~1.0.1",
    "webpack": "~4.12.0",
    "webpack-cli": "^3.0.3"
  },
  "publishConfig": {
    "access": "public"
  },
  "jupyterlab": {
    "extension": true,
    "themeDir": "static"
  }
}

0 个答案:

没有答案