Skip to content

Commit fe0bb61

Browse files
staredclaude
andcommitted
Update docs to reflect Vue 3 component structure
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 3a3fbfa commit fe0bb61

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@
5555

5656
## Technical Approach
5757

58-
**Minimal Dependencies**
58+
**Stack**
59+
- Vue 3 with Composition API
5960
- KaTeX for math rendering
60-
- Simple markdown parser
61-
- No heavy frameworks (React, etc.) unless needed
62-
- Plain TypeScript + Vite
61+
- CodeJar + Prism for editor
62+
- Vite for build tooling
6363

6464
**Data-Driven**
6565
- No hardcoded content in JavaScript

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ A minimal framework for creating interactive mathematical explanations with colo
1616
- **Markdown-based**: Write equations in simple markdown format
1717
- **Interactive**: Hover over colored terms to see definitions
1818
- **Accessible**: Multiple color schemes including color-blind friendly options
19-
- **Minimal**: Built with KaTeX, CodeJar, and Prism (~10KB total)
19+
- **Minimal**: Built with Vue 3, KaTeX, CodeJar, and Prism
20+
- **Export**: Generate standalone HTML, LaTeX, Beamer, or Typst output
2021
- **Editable**: Real-time editor for creating and modifying equations
2122

2223
## Content Format
@@ -113,10 +114,15 @@ public/examples/ # Equation markdown files
113114
├── equations.json # List of available equations
114115
└── *.md # Individual equation files
115116
src/
116-
├── main.ts # Main app logic & editor
117-
├── parser.ts # Markdown → KaTeX/HTML parser
118-
├── prism-custom.ts # Syntax highlighting for editor
119-
└── style.css # Tufte-inspired minimal styles
117+
├── main.ts # Vue app entry point
118+
├── App.vue # Main app layout with three-panel design
119+
├── components/
120+
│ ├── CentralPanel.vue # Equation display with hover interactions
121+
│ ├── MarkdownEditor.vue # CodeJar editor with Prism highlighting
122+
│ ├── controls/ # EquationSelector, ColorSchemeSwitcher, ExportControls
123+
│ └── equation/ # EquationDisplay, DescriptionPanel, DefinitionPopup
124+
├── export/ # Export formats (HTML, LaTeX, Beamer, Typst)
125+
└── utils/ # parser.ts, colorSchemes.ts, termDom.ts
120126
```
121127

122128
## Author

0 commit comments

Comments
 (0)