Files
MD.ai/CLAUDE.md

61 lines
2.4 KiB
Markdown
Raw Normal View History

2025-06-20 09:06:01 -07:00
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
2025-06-20 10:14:52 -07:00
This repository contains a macOS markdown viewer application built with SwiftUI. The app allows users to open markdown files and render them with HTML preview in individual windows.
2025-06-20 09:06:01 -07:00
## Development Commands
2025-06-20 10:14:52 -07:00
- Build: `xcodebuild -project MarkdownViewer.xcodeproj -scheme MarkdownViewer -configuration Debug`
- Clean: `xcodebuild clean -project MarkdownViewer.xcodeproj`
- Open in Xcode: `open MarkdownViewer.xcodeproj`
2025-06-20 09:06:01 -07:00
## Architecture & Structure
2025-06-20 10:14:52 -07:00
- **MarkdownViewerApp.swift**: Main app entry point with Settings scene and File menu integration
- **ContentView.swift**: Contains MarkdownDocumentView for displaying markdown content
- **MarkdownRenderer.swift**: NSViewRepresentable wrapper for WKWebView with markdown-to-HTML conversion
- **MarkdownViewer.entitlements**: App entitlements with sandbox disabled for WebView functionality
2025-06-20 09:06:01 -07:00
## Getting Started
2025-06-20 10:14:52 -07:00
1. Open the project: `open MarkdownViewer.xcodeproj`
2. Build and run the application in Xcode (⌘R)
3. Use File → Open Markdown File (⌘O) to open markdown files
4. Each file opens in its own window with rendered HTML preview
## TODO - Feature Ideas
*Add new feature ideas here that can be worked on in future development sessions*
### Markdown Viewer Enhancements
- [ ] Add syntax highlighting for code blocks
- [ ] Support for markdown tables
- [ ] Add print functionality
- [ ] Export to PDF feature
- [ ] Dark mode support
- [ ] Custom CSS themes
- [x] Live preview while editing
2025-06-20 10:14:52 -07:00
- [ ] Search within document
- [ ] Zoom in/out functionality
- [x] Recent files menu
- [x] Save functionality via File menu (Save/Save As with ⌘S/⌘⇧S shortcuts)
2025-06-20 10:14:52 -07:00
- [ ] Drag and drop file support
- [ ] Support for math equations (LaTeX)
- [ ] Image paste support
- [ ] Full-screen reading mode
- [ ] Support for markdown extensions (strikethrough, task lists, etc.)
- [ ] Auto-save functionality for edited files
- [ ] Split view with source and preview
- [ ] Outline/table of contents sidebar
- [ ] Word count and reading time estimation
### Technical Improvements
- [ ] Add unit tests for markdown parsing
- [ ] Implement proper error handling and user feedback
- [ ] Add app icon and proper branding
- [ ] Optimize performance for large markdown files
- [ ] Add preferences/settings window
- [ ] Implement proper document state management