Skip to content

Commit 99db832

Browse files
b451cclaude
andcommitted
docs: update README and bump version to 1.3
- README: add Search, ToC, Blockquotes, Reference Links, Custom Themes to Features, Keyboard Shortcuts, Project Structure, and Roadmap - Bump MARKETING_VERSION 1.2.1 → 1.3 in project.pbxproj Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent dac67f8 commit 99db832

2 files changed

Lines changed: 34 additions & 10 deletions

File tree

QuickMD/QuickMD.xcodeproj/project.pbxproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@
364364
"$(inherited)",
365365
"@executable_path/../Frameworks",
366366
);
367-
MARKETING_VERSION = 1.2.1;
367+
MARKETING_VERSION = 1.3;
368368
PRODUCT_BUNDLE_IDENTIFIER = pl.falami.studio.QuickMD;
369369
PRODUCT_NAME = "$(TARGET_NAME)";
370370
PROVISIONING_PROFILE_SPECIFIER = "";
@@ -408,7 +408,7 @@
408408
"$(inherited)",
409409
"@executable_path/../Frameworks",
410410
);
411-
MARKETING_VERSION = 1.2.1;
411+
MARKETING_VERSION = 1.3;
412412
PRODUCT_BUNDLE_IDENTIFIER = pl.falami.studio.QuickMD;
413413
PRODUCT_NAME = "$(TARGET_NAME)";
414414
PROVISIONING_PROFILE_SPECIFIER = "";

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,25 @@ Perfect for developers, writers, students, and anyone who works with Markdown da
3434
- ✅ Task lists with checkboxes (`- [ ]` / `- [x]`)
3535
- ✅ Nested lists (ordered and unordered)
3636
- ✅ Images (local and remote URLs)
37-
- ✅ Links, blockquotes, horizontal rules
37+
- ✅ Links (inline, reference-style, autolinks)
38+
- ✅ Nested blockquotes with level indicators
39+
- ✅ Horizontal rules
40+
41+
### 🔍 **Navigation & Search**
42+
- Find in document (`⌘F`) with match count and navigation
43+
- Table of Contents sidebar (`⌘⇧T`) — auto-generated from headings
44+
- Export to PDF (`⌘⇧E`) and Print (`⌘P`)
45+
46+
### 🎨 **Custom Themes**
47+
- 7 built-in themes: Auto, Solarized Light/Dark, Dracula, GitHub, Gruvbox Dark, Nord
48+
- Settings panel (`⌘,`) with color previews
49+
- Theme persists across app restarts
3850

3951
### 💻 **Developer-Friendly**
4052
- Syntax highlighting for 10+ languages (Swift, Python, JavaScript, Go, Rust, etc.)
4153
- Perfect for README files and documentation
4254
- Handles AI-generated markdown perfectly
43-
- Dark mode that follows system settings
55+
- Dark mode that follows system settings (or choose a fixed theme)
4456

4557
### 🔒 **Privacy Focused**
4658
- No analytics, no tracking
@@ -110,8 +122,12 @@ Now all your Markdown files will open instantly with QuickMD!
110122
|----------|--------|
111123
| `⌘O` | Open file |
112124
| `⌘W` | Close window |
125+
| `⌘F` | Find in document |
126+
| `⌘G` / `⇧⌘G` | Next / previous match |
127+
| `⌘⇧T` | Toggle Table of Contents |
113128
| `⌘⇧E` | Export to PDF |
114129
| `⌘P` | Print |
130+
| `⌘,` | Settings (theme picker) |
115131

116132
## Tech Stack
117133

@@ -122,9 +138,11 @@ Now all your Markdown files will open instantly with QuickMD!
122138

123139
### Key Components
124140

125-
- Custom Markdown parser with block-level parsing
141+
- Custom Markdown parser with block-level parsing and reference link pre-pass
126142
- Regex-based syntax highlighting for code blocks
143+
- 7 color themes with `@AppStorage` persistence
127144
- `AsyncImage` for remote image rendering
145+
- Per-block PDF export with multi-page pagination
128146
- Native SwiftUI components for performance
129147

130148
## Project Structure
@@ -138,14 +156,18 @@ QuickMD/
138156
│ ├── MarkdownBlock.swift # Block type enum
139157
│ ├── MarkdownBlockParser.swift # Line-by-line block parser
140158
│ ├── MarkdownRenderer.swift # Inline markdown → AttributedString
141-
│ ├── MarkdownTheme.swift # Color themes + regex patterns
159+
│ ├── MarkdownTheme.swift # 7 color themes, regex patterns
142160
│ ├── MarkdownExport.swift # PDF export + print support
143161
│ ├── TipJarManager.swift # StoreKit 2 IAP (App Store only)
144162
│ ├── TipJarView.swift # Tip Jar UI (App Store only)
145163
│ ├── Views/
146164
│ │ ├── CodeBlockView.swift # Syntax-highlighted code blocks
147165
│ │ ├── TableBlockView.swift # Table rendering with alignment
148-
│ │ └── ImageBlockView.swift # Local + remote image rendering
166+
│ │ ├── ImageBlockView.swift # Local + remote image rendering
167+
│ │ ├── BlockquoteView.swift # Nested blockquotes
168+
│ │ ├── SearchBar.swift # Find in document (⌘F)
169+
│ │ ├── TableOfContentsView.swift # ToC sidebar (⌘⇧T)
170+
│ │ └── ThemePickerView.swift # Theme settings (⌘,)
149171
│ └── Assets.xcassets/ # App icon + assets
150172
├── CHANGELOG.md # Version history
151173
├── AppStore-Metadata.md # App Store descriptions (EN/PL)
@@ -201,11 +223,13 @@ QuickMD is **free and open source**. If you find it useful, consider supporting
201223

202224
- [x] Export to PDF (`⌘⇧E`) and Print (`⌘P`)
203225
- [x] Syntax highlighting for code blocks
204-
- [ ] Table of contents navigation
205-
- [ ] Custom themes
226+
- [x] Find & search within document (`⌘F`)
227+
- [x] Nested blockquotes with level indicators
228+
- [x] Table of Contents sidebar (`⌘⇧T`)
229+
- [x] Reference-style links (`[text][id]`)
230+
- [x] Custom color themes (7 built-in)
206231
- [ ] LaTeX math support
207232
- [ ] Mermaid diagram rendering
208-
- [ ] Find & search within document
209233

210234
Have a feature request? [Open an issue!](https://github.com/b451c/quickmd/issues)
211235

0 commit comments

Comments
 (0)