使用 pip 安装
-
更新 pip:
pip install --user --upgrade pip
-
安装 Kitsunebi:
pip install kitsunebi
或者(如果使用 Python 3):
pip3 install kitsunebi
-
完成安装: 安装完成后,Kitsunebi的文档和示例笔记本会被创建在你的用户目录中。
从源码安装
-
克隆仓库:
git clone https://github.com/kitsunebi/kitsunebi.git cd kitsunebi
-
安装依赖:
pip install -r requirements.txt
-
运行测试:
make test
测试完成后,会生成
html文件,打开它查看结果。
使用 Conda
-
安装 Conda(如果尚未安装):
conda install conda
-
安装 Kitsunebi:
conda install -c conda-forge kitsunebi
使用方法
- 打开 Jupyter Notebook。
- 创建新的笔记本。
- 选择 Markdown,然后点击右上角的 Extensions 按钮。
- 选择 Kitsunebi,然后选择一个模板开始使用。
注意事项
- 权限:确保有足够的权限安装软件,必要时使用管理员权限运行命令。
- 依赖:确保 Python >=3.6 和相应的依赖已安装。
- 文档位置:安装后,文档和示例在用户主目录下,路径为
~/.kitsunebi/。
常见问题
- 权限问题:使用
pip install --user可以避免权限问题。 - 依赖问题:确保安装前所有依赖已正确安装。
- Python版本:确保使用正确的 Python 版本。
安装完成后,Kitsunebi 将为你提供基于 Markdown 的丰富编辑功能,增强 Jupyter Notebook 的使用体验。









