obsidian-plugin/ytliu74_obsidian-pseudocode
1
0
Fork 0
mirror of https://github.com/ytliu74/obsidian-pseudocode.git synced 2026-07-22 07:40:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: Add preamble.sty support

Browse source
This commit is contained in:
Yaotian-Liu 2023-05-19 21:19:03 +08:00
parent 8d014eeb96
commit dfeb6ad4d1
No known key found for this signature in database
GPG key ID: FB9E38CC4C16D871
2 changed files with 61 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
main.ts
View file

@ -10,9 +10,11 @@ import {
PluginSettingTab,
Setting,
TFile,
Notice,
} from "obsidian";
import * as pseudocode from "pseudocode";
import * as katex from "katex";
// This is the setting for pseudocode.js
interface PseudocodeJsSettings {
@ -27,11 +29,13 @@ interface PseudocodeJsSettings {
// Setting for this plugin
interface PseudocodeSettings {
blockSize: number;
preamblePath: string;
jsSettings: PseudocodeJsSettings;
}
const DEFAULT_SETTINGS: PseudocodeSettings = {
blockSize: 99,
preamblePath: "preamble.sty",
jsSettings: {
indentSize: "1.2em",
commentDelimiter: "//",
@ -43,12 +47,16 @@ const DEFAULT_SETTINGS: PseudocodeSettings = {
};
const PseudocodeBlockInit =
"```pseudo\n\t\\begin{algorithm}\n\t\\caption{Algo Caption}\n\t\\begin{algorithmic}\n\n\t\\end{algorithmic}\n\t\\end{algorithm} \n```";
"```pseudo\n" +
"\t\\begin{algorithm}\n\t\\caption{Algo Caption}\n\t\\begin{algorithmic}" +
"\n\n\t\\end{algorithmic}\n\t\\end{algorithm}" +
"\n```";
const BLOCK_NAME = "pseudo";
export default class PseudocodePlugin extends Plugin {
settings: PseudocodeSettings;
preamble: string;
async pseudocodeHandler(
source: string,
@ -59,6 +67,13 @@ export default class PseudocodePlugin extends Plugin {
const blockWidth = this.settings.blockSize;
blockDiv.style.width = `${blockWidth}em`;
// find all $ enclosements in source, and add the preamble.
// TODO: Might be able to optimize.
const mathRegex = /\$(.*?)\$/g;
source = source.replace(mathRegex, (match, group1) => {
return '$' + this.preamble + group1 + '$';
});
const preEl = blockDiv.createEl("pre", { cls: "code", text: source });
try {
@ -74,6 +89,7 @@ export default class PseudocodePlugin extends Plugin {
async onload() {
await this.loadSettings();
await this.loadPreamble();
this.registerMarkdownCodeBlockProcessor(
BLOCK_NAME,
@ -98,6 +114,30 @@ export default class PseudocodePlugin extends Plugin {
onunload() { }
async loadPreamble() {
try { this.preamble = await this.app.vault.adapter.read(this.settings.preamblePath); }
catch (error) {
console.log(error);
// Extract the search path from the error message.
const searchPath = error.message.match(/'(.*?)'/g)[0];
new Notice("Pseudocode Plugin: Preamble file not found at " + searchPath + ".");
this.preamble = "";
return;
}
try {
katex.renderToString(this.preamble);
console.log("Preamble file loaded.");
new Notice("Pseudocode Plugin: Preamble file loaded.");
}
catch (error) {
console.log(error);
new Notice("Pseudocode Plugin: Preamble file contains invalid LaTeX. " +
"Please refer to console for details.");
this.preamble = "";
}
}
async loadSettings() {
this.settings = Object.assign(
{},
@ -143,6 +183,24 @@ class PseudocodeSettingTab extends PluginSettingTab {
})
);
// Instantiate Preamble Path setting
new Setting(containerEl)
.setName("Preamble Path")
.setDesc(
"The path to the preamble file. The preamble file is a .tex file that contains" +
" the preamble of the LaTeX document. This is useful if you want to use custom" +
" packages or commands in your pseudocode."
)
.addText((text) =>
text
// .setValue(this.plugin.settings.preamblePath)
.setValue(this.plugin.settings.preamblePath)
.onChange(async (value) => {
this.plugin.settings.preamblePath = value;
await this.plugin.saveSettings();
})
);
// Instantiate Indent Size setting
new Setting(containerEl)
.setName("Indent Size")

3
package.json
View file

@ -19,7 +19,8 @@
"esbuild": "0.17.3",
"obsidian": "latest",
"tslib": "2.4.0",
"typescript": "4.7.4"
"typescript": "4.7.4",
"@types/katex": "0.11.1"
},
"dependencies": {
"pseudocode": "Yaotian-Liu/pseudocode.js#master",