Compare commits

..

15 commits

Author SHA1 Message Date
Yaotian-Liu
5ace9075db
new release 1.6.5 2026-05-05 18:00:30 -07:00
Yaotian-Liu
6adbd70bef
new release 1.6.4 2026-01-15 15:49:00 -07:00
Yaotian-Liu
935403182e
new release 1.6.3 2026-01-01 16:25:20 -05:00
Yaotian-Liu
91df3ded05
chore: Add CLAUDE.md and update the pseudocode.js 2026-01-01 16:24:15 -05:00
Yaotian-Liu
4bb26746dd
new release 1.6.2 2025-11-11 15:55:36 -07:00
Yaotian Liu
a9aed6f856
Merge pull request #29 from Nambers/clickEdit
Enable Click edit
2025-11-11 15:51:09 -07:00
Eritque arcus
1c3846f0a2
chore: use soft null check 2025-11-09 23:58:25 -06:00
Eritque arcus
100c1c5bad
fix: fix click button will also enter edit 2025-11-09 23:56:00 -06:00
Eritque arcus
6614713042
chore: cleanup 2025-11-09 22:01:39 -06:00
Eritque arcus
1acc571cae
feat: implement click-edit 2025-11-09 21:59:29 -06:00
Yaotian Liu
d677e7a5d2
Update README.md 2025-02-03 18:08:36 -07:00
Yaotian-Liu
47f5b562c7
new release 1.6.1 2024-08-31 16:46:19 -07:00
Yaotian Liu
13be11b65a
Merge pull request #22 from anton-dergunov/patch-1
Right alignment for the comments
2024-08-31 16:42:43 -07:00
Anton Dergunov
bdec504edc
Right alignment for the comments
Make the comments look more like in LaTeX package documentation: https://ctan.math.washington.edu/tex-archive/macros/latex/contrib/algpseudocodex/algpseudocodex.pdf
2024-08-31 23:34:49 +01:00
Yaotian-Liu
882556f4e3
build: Update release workflow 2024-06-05 11:19:23 -07:00
9 changed files with 138 additions and 19 deletions

View file

@ -22,7 +22,7 @@ jobs:
- name: Install Dependencies
run: |
npm config set registry http://registry.npmjs.org/
npm config set registry https://registry.npmjs.org/
npm install
- name: Build

94
CLAUDE.md Normal file
View file

@ -0,0 +1,94 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
Obsidian-Pseudocode is an Obsidian plugin that renders LaTeX-style pseudocode inside code blocks. It uses pseudocode.js to convert LaTeX algorithmic constructs to HTML, with support for math formulas via KaTeX.
## Build and Development Commands
```bash
# Development mode with file watching
npm run dev
# Production build (includes TypeScript type checking)
npm run build
# Version bump
npm run version
```
## Architecture
### Plugin Entry Point
- `main.ts`: Core plugin class (`PseudocodePlugin`)
- Registers markdown code block processor for `pseudo` language
- Manages settings and preamble loading
- Handles theme observer lifecycle
### Core Processing Flow
1. User creates a code block with `pseudo` language specifier
2. `pseudocodeHandler()` in main.ts processes the block:
- Extracts inline macros (before `\begin{algorithm}`)
- Combines with global preamble if enabled
- Injects preamble into all math expressions (`$...$`)
- Renders using pseudocode.js library
- Adds export button and applies theme
### Key Modules
**src/inline_macro.ts**
- Separates inline macro definitions from algorithm content
- Macros before `\begin{algorithm}` are treated as preamble
**src/latex_translator.ts**
- Converts unsupported LaTeX macros to KaTeX-compatible commands
- Handles `\DeclarePairedDelimiter`, `\DeclareMathOperator*`, `\DeclareMathOperator`
- Validates macros using KaTeX parser and converts `\newcommand` to `\renewcommand` when redefining
**src/export_button.ts**
- Creates "Export to clipboard" button for each pseudocode block
- Generates compilable LaTeX document with required packages (algorithm, algpseudocodex, amsmath)
- Includes both global and inline macros
**src/theme.ts**
- MutationObserver watches document.body for theme changes
- Applies Obsidian theme colors (--background-primary, --text-normal) to pseudocode blocks
- Updates .ps-root, .ps-algorithm, and border colors dynamically
**src/setting_tab.ts**
- UI for plugin settings (block size, preamble path, line numbers, theme following, etc.)
**src/auto_complete.ts**
- EditorSuggestor for autocomplete within `pseudo` code blocks
### Build System
- Uses esbuild (config in `esbuild.config.mjs`)
- Bundles to CommonJS format targeting ES2018
- Main entry: `main.ts``main.js`
- External: Obsidian API, CodeMirror 6, Electron
## Important Implementation Details
### Preamble System
- Global preamble: loaded from file (default `preamble.sty`)
- Inline preamble: defined per-block before `\begin{algorithm}`
- Preamble is injected into every math expression in the pseudocode
- Must reload plugin after changing global preamble file
### Theme Integration
- When `followSystemTheme` is enabled, plugin observes Obsidian theme changes
- CSS custom properties are read from document.body and applied to rendered pseudocode
- Observer must be detached on plugin unload to prevent memory leaks
### Error Handling
- Pseudocode rendering errors display in-block with ✖ symbol
- Preamble loading failures show Notice to user
- Invalid LaTeX in preamble is caught and logged to console
## Dependencies
- `pseudocode`: Uses forked version from ytliu74/pseudocode.js#master
- `katex`: Fixed at 0.11.1 for macro rendering
- `obsidian`: Latest API
- TypeScript 4.7.4 with strict null checks enabled

View file

@ -22,6 +22,7 @@ This is a plugin for [Obsidian](https://obsidian.md/) that allows you to render
- Auto-completion inside `pseudo` code block. (Release 1.1.0)
- [Preamble style (macros) customization.](#preamble-style-customization) (Release 1.2.0 & 1.5.0)
- [Export a LaTeX file that can be compiled, including any required additional macros.](#export-to-a-compilable-latex-file) (Release 1.3.0)
- Pseudocode block follows Obsidian theme and supports both light and dark ones. (Release 1.6.0)
### Future Features

View file

@ -30,6 +30,15 @@ export default class PseudocodePlugin extends Plugin {
const blockDiv = el.createDiv({ cls: "pseudocode-block" });
const blockWidth = this.settings.blockSize;
blockDiv.style.width = `${blockWidth}em`;
blockDiv.addEventListener("click", (event) => {
const target = (event.target as HTMLElement | null);
if(target && target.tagName !== 'BUTTON')
(target
.closest('.pseudocode-block')
?.parentElement?.parentElement
?.querySelector('.edit-block-button') as HTMLElement | null)
?.click();
});
// Extract inline macros
const [inlineMacros, nonMacroLines] = extractInlineMacros(source);

View file

@ -1,7 +1,7 @@
{
"id": "pseudocode-in-obs",
"name": "Pseudocode",
"version": "1.6.0",
"version": "1.6.5",
"minAppVersion": "0.15.0",
"description": "This is an obsidian plugin that helps to render a LaTeX-style pseudocode inside a code block.",
"author": "Yaotian Liu",

8
package-lock.json generated
View file

@ -1,16 +1,16 @@
{
"name": "pseudocode-in-obs",
"version": "1.5.4",
"version": "1.6.4",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "pseudocode-in-obs",
"version": "1.5.4",
"version": "1.6.4",
"license": "MIT",
"dependencies": {
"katex": "0.11.1",
"pseudocode": "ytliu74/pseudocode.js#master"
"pseudocode": "github:ytliu74/pseudocode.js#master"
},
"devDependencies": {
"@types/katex": "0.11.1",
@ -1888,7 +1888,7 @@
},
"node_modules/pseudocode": {
"version": "2.3.0",
"resolved": "git+ssh://git@github.com/ytliu74/pseudocode.js.git#4ac293a977b191d66b3cba640804814651c95aaf",
"resolved": "git+ssh://git@github.com/ytliu74/pseudocode.js.git#db17188d06528b12b3279f4f1025c1a978519d1e",
"license": "MIT"
},
"node_modules/punycode": {

View file

@ -1,6 +1,6 @@
{
"name": "pseudocode-in-obs",
"version": "1.6.0",
"version": "1.6.5",
"description": "This is an obsidian plugin that helps to render a LaTeX-style pseudocode inside a code block.",
"main": "main.js",
"scripts": {
@ -12,6 +12,7 @@
"author": "",
"license": "MIT",
"devDependencies": {
"@types/katex": "0.11.1",
"@types/node": "^16.11.6",
"@typescript-eslint/eslint-plugin": "5.29.0",
"@typescript-eslint/parser": "5.29.0",
@ -19,11 +20,10 @@
"esbuild": "0.17.3",
"obsidian": "latest",
"tslib": "2.4.0",
"typescript": "4.7.4",
"@types/katex": "0.11.1"
"typescript": "4.7.4"
},
"dependencies": {
"pseudocode": "ytliu74/pseudocode.js#master",
"katex": "0.11.1"
"katex": "0.11.1",
"pseudocode": "github:ytliu74/pseudocode.js#master"
}
}

View file

@ -1399,12 +1399,22 @@ If your plugin does not need CSS, delete this file.
text-transform: none;
}
.ps-root .ps-comment {
font-family: KaTeX_Main, "Times New Roman", Times, serif;
font-weight: 400;
font-variant: normal;
font-style: normal;
text-transform: none;
.ps-root {
font-family: KaTeX_Main, "Times New Roman", Times, serif;
font-weight: 400;
font-variant: normal;
font-style: normal;
text-transform: none;
}
.ps-comment {
font-family: KaTeX_Main, "Times New Roman", Times, serif;
font-weight: 400;
font-variant: normal;
font-style: italic;
text-transform: none;
opacity: 70%;
float: right;
}
.ps-root .ps-linenum {
@ -1468,4 +1478,4 @@ If your plugin does not need CSS, delete this file.
background-color: white;
opacity: 1;
color: black;
}
}

View file

@ -32,5 +32,10 @@
"1.5.6": "0.15.0",
"1.5.7": "0.15.0",
"1.5.8": "0.15.0",
"1.6.0": "0.15.0"
"1.6.0": "0.15.0",
"1.6.1": "0.15.0",
"1.6.2": "0.15.0",
"1.6.3": "0.15.0",
"1.6.4": "0.15.0",
"1.6.5": "0.15.0"
}