From 91df3ded05d40ca2803ae5df80a448277d42c394 Mon Sep 17 00:00:00 2001
From: Yaotian-Liu <yaotian_liu@gmx.com>
Date: Thu, 1 Jan 2026 16:24:15 -0500
Subject: [PATCH] chore: Add CLAUDE.md and update the pseudocode.js

---
 CLAUDE.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 CLAUDE.md

diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..ad79e34
--- /dev/null
+++ b/CLAUDE.md
@@ -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