Claude.md improvements
This commit is contained in:
60
CLAUDE.md
60
CLAUDE.md
@@ -4,33 +4,57 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
|
||||
## Project Overview
|
||||
|
||||
This is a new repository (`md.ai`) that appears to be related to AI/ML development based on the repository name and location structure.
|
||||
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.
|
||||
|
||||
## Development Commands
|
||||
|
||||
*Note: This repository is currently empty. Update this section as build tools, package managers, and testing frameworks are added.*
|
||||
|
||||
Common commands to add:
|
||||
- Build: `[to be determined based on chosen framework]`
|
||||
- Test: `[to be determined based on chosen testing framework]`
|
||||
- Lint: `[to be determined based on chosen linting tools]`
|
||||
- Dev server: `[to be determined based on chosen development setup]`
|
||||
- Build: `xcodebuild -project MarkdownViewer.xcodeproj -scheme MarkdownViewer -configuration Debug`
|
||||
- Clean: `xcodebuild clean -project MarkdownViewer.xcodeproj`
|
||||
- Open in Xcode: `open MarkdownViewer.xcodeproj`
|
||||
|
||||
## Architecture & Structure
|
||||
|
||||
*Note: Project architecture will be documented here as the codebase develops.*
|
||||
- **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
|
||||
|
||||
## Getting Started
|
||||
|
||||
This is a fresh repository. When beginning development:
|
||||
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
|
||||
|
||||
1. Choose and set up the appropriate framework/language stack
|
||||
2. Add package.json (for Node.js) or equivalent dependency management files
|
||||
3. Set up testing framework and basic project structure
|
||||
4. Update this CLAUDE.md with specific commands and architecture details
|
||||
## TODO - Feature Ideas
|
||||
|
||||
## Notes for Future Development
|
||||
*Add new feature ideas here that can be worked on in future development sessions*
|
||||
|
||||
- Update the "Development Commands" section once build tools are configured
|
||||
- Document the chosen architecture and key design patterns
|
||||
- Add any project-specific conventions or guidelines
|
||||
### 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
|
||||
- [ ] Live preview while editing
|
||||
- [ ] Search within document
|
||||
- [ ] Zoom in/out functionality
|
||||
- [ ] Recent files menu
|
||||
- [ ] 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
|
||||
Reference in New Issue
Block a user