Obsidian 插件:Pseudocode
插件名片
概述
帮助在代码块中渲染类似 LaTeX 风格的伪代码。
原文出处
下面自述文件的来源于 Readme
Readme(翻译)
下面是 pseudocode-in-obs 插件的自述翻译
Obsidian-Pseudocode
这是一个为 Obsidian 设计的插件,允许您在代码块中渲染类似 LaTeX 风格的伪代码。该插件基于 pseudocode.js,这是一个将伪代码美观地排版为 HTML 的 JavaScript 库。
特点
- 直观的语法:该插件采用类似于 LaTeX 的输入方式,支持 LaTeX 算法包中的算法结构。无论是否有 LaTeX 经验,用户都应该会发现该语法相当直观。
- 打印质量:该插件生成的 HTML 输出与由 LaTeX 排版的出版物上打印的漂亮算法(几乎)完全相同。
- 数学公式支持:在伪代码中插入数学公式就像 LaTeX 一样简单。只需用
$...$
或\(...\)
将数学表达式括起来即可。 - 在
pseudo
代码块内自动补全。(1.1.0 版本发布) - 自定义导言样式(宏)。(1.2.0 和 1.5.0 版本发布)
- 导出可编译的LaTeX文件,包括任何所需的额外宏。(1.3.0 版本发布)
未来功能
- 语法高亮。
使用方法
基本
要使用该插件,只需在 Obsidian 笔记中创建一个代码块,并在其中添加伪代码。然后,在代码块中添加语言指示符 pseudo
(代表 ” 伪代码 ”)。插件将自动将伪代码渲染为 LaTeX。
推荐:使用命令 Pseudocode: Insert a new pseudocode block
开始。
以下是一个示例:
```pseudo
\begin{algorithm}
\caption{快速排序}
\begin{algorithmic}
\Procedure{Quicksort}{$A, p, r$}
\If{$p < r$}
\State $q \gets $ \Call{Partition}{$A, p, r$}
\State \Call{Quicksort}{$A, p, q - 1$}
\State \Call{Quicksort}{$A, q + 1, r$}
\EndIf
\EndProcedure
\Procedure{Partition}{$A, p, r$}
\State $x \gets A[r]$
\State $i \gets p - 1$
\For{$j \gets p$ \To $r - 1$}
\If{$A[j] < x$}
\State $i \gets i + 1$
\State 交换
$A[i]$ 和 $A[j]$
\EndIf
\State 交换 $A[i]$ 和 $A[r]$
\EndFor
\EndProcedure
\end{algorithmic}
\end{algorithm}
```
这将被渲染为(要渲染行号,您需要在设置选项卡中切换):

导言样式定制
使用 .sty
文件
您可以使用 .sty
文件(实际上后缀无关紧要)来自定义一些宏。插件将根据设置来定位文件。默认路径为 preamble.sty
。
在更改导言文件后,请重新加载插件。
在块内引导中使用
您可以在 \begin{algorithm}
之前的伪代码块中编写自己的宏。这些宏仅适用于此特定块内。
支持的宏
目前支持的宏可以在 此链接 和下方找到(可能不完全支持):
\DeclarePairedDelimiter
\DeclareMathOperator*
\DeclareMathOperator
您可以通过单击每个伪代码块右下角的“导出到剪贴板”按钮,轻松导出一个可编译的 LaTeX 文件。插件将自动将一个可编译的 LaTeX 文件,包括任何所需的额外宏,生成到您的剪贴板中。
安装
:tada: 伪代码插件现在可以在 Obsidian 的社区插件部分找到。要安装它,只需搜索Pseudocode并点击安装按钮。
手动安装
- 在 Obsidian 的插件文件夹(即{你的 Vault}/.obsidian/plugins)中创建一个名为
pseudocode-in-obs
的文件夹。 - 从 发布页面 下载
main.js
、manifest.json
和styles.css
,并将它们放入步骤 1 中创建的文件夹中。 - 打开 Obsidian,在“Community Plugins”设置页面中启用该插件。
- 尽情使用。
鸣谢
该插件基于 pseudocode.js 开发,这是一个将伪代码美观地排版为 HTML 的 JavaScript 库。非常感谢 pseudocode.js 团队的出色工作!
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。