跳转到主要内容

Jupyter笔记本扩展,支持(某些)Markdown单元格中的LaTeX环境。还提供对标签和交叉引用、文档范围内编号、参考文献等功能的支持...

项目描述

此Jupyter笔记本扩展允许在Markdown单元格中使用某些LaTeX命令和环境。

  1. LaTeX命令和环境

    • 支持Markdown单元格中的某些LaTeX命令,例如\\textit\\textbf\\underline

    • 支持类似定理的环境,支持标签和交叉引用

    • 支持列表:enumerate, itemize

    • 对图环境有限支持,

    • 支持listing环境,

    • 额外的textboxa环境

  2. 引文和参考文献

    • 支持\\cite,并创建参考文献部分

  3. 方程和环境的全文档编号,支持“label”和“ref”

  4. 配置工具栏

  5. LaTeX_envs下拉菜单,用于快速插入环境

  6. 用户LaTeX定义文件可以加载并使用

  7. 使用自定义导出器导出到纯HTML、幻灯片和LaTeX

  8. 用户可以在user_envs.json配置文件中自定义环境的标题/编号。

  9. 样式可以在latex_env.css样式表中自定义

  10. 自动完成 $, (, {, [,用于LaTeX命令和环境

可以通过user_envs.json或源文件(thmsInNb4.js)简单添加更多环境。

可以将笔记本导出为纯文本 \(\LaTeX\) 和 html 格式,同时保留 latex_envs 笔记本扩展的所有功能。我们提供了专门的导出器、预处理器和后处理器、模板。我们还添加了入口点以简化转换过程。现在转换过程变得非常简单:

jupyter nbconvert --to html_with_lenvs FILE.ipynb

jupyter nbconvert --to latex_with_lenvs FILE.ipynb

FILE.ipynb 转换为 html/latex 格式,同时保留 latex_envs 笔记本扩展的所有功能。其他选项包括 slides_with_lenvs,用于转换为 reveal-js 演示文稿,以及 html_with_toclenvs 以包含目录。LaTeX 转换器还公开了几个转换选项(请参阅 文档)。

演示/文档

包含示例笔记本及其 html 和 pdf 版本的 doc 子目录。这充当文档。提供了一个示例笔记本 latex_env_doc.ipynb。其 html 版本为 latex_env_doc.html,用作 文档

安装

该扩展由一个包含一个 JavaScript 笔记本扩展以及用于 nbconvert 支持的 Python 代码的 pypi 包组成。从 Jupyter 4.2 开始,pypi 是推荐分发 nbextensions 的方式。可以通过以下方式安装扩展

  • 从 github 仓库的 master 版本(这将始终是最新的版本)

  • 通过 pip 安装 Pypi 上的版本

  • 通过 conda,从 conda-forge 频道

  • 作为伟大的 jupyter_contrib_nbextensions 收藏的一部分。按照那里的说明进行安装。完成后,您可以在 http://localhost:8888/nbextensions 上打开一个标签页以启用和配置各种扩展。

从 github 仓库或从 Pypi,

  1. 安装包

    • pip3 install https://github.com/jfbercher/jupyter_latex_envs/archive/master.zip [--user][--upgrade]

    • pip3 install jupyter_latex_envs [--user][--upgrade]

    • 或克隆仓库并安装 git clone https://github.com/jfbercher/jupyter_latex_envs.git python3 setup.py install

  2. 安装笔记本扩展

    jupyter nbextension install --py latex_envs [--user|--sys-prefix|--system]
  3. 并启用它

    jupyter nbextension enable --py latex_envs [--user|--sys-prefix|--system]

对于 4.2 版本之前的 Jupyter,步骤 1 之后的情形更为复杂,因为 --py 选项不可用,因此您需要手动找到源文件的位置,如下所示(根据 [@jcb91](https://github.com/jcb91)’s jupyter_highlight_selected_word 的说明进行修改)。执行以下操作:

python -c "import os.path as p; from latex_envs import __file__ as f, _jupyter_nbextension_paths as n; print(p.normpath(p.join(p.dirname(f), n()[0]['src'])))"

然后,发出

jupyter nbextension install <output source directory>
jupyter nbextension enable latex_envs/latex_envs

其中 <output source directory> 是第一个 Python 命令的输出。

免责声明、来源和致谢

最初,我使用了一些来自优秀的在线 markdown 编辑器 stackedit 的代码,该编辑器的作者也考虑了在 markdown 中包含 LaTeX 标记的问题。

我还研究并使用了来自 ipython-contrib/jupyter_contrib_nbextensions 的示例和代码。

  • 这旨在使其有用。然而,代码和文档中还有许多可能的改进。 欢迎和高度赞赏贡献。

  • 如果您遇到问题,请在以下链接处提交问题:https://github.com/jfbercher/jupyter_latex_envs/issues 这里

自我推广 – 喜欢使用 latex_envs?请星标并关注GitHub上的仓库

项目详情


下载文件

下载您平台对应的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

jupyter_latex_envs-1.4.6.tar.gz (861.7 kB 查看哈希值)

上传时间

支持者