Skip to content

Commit e1febf0

Browse files
committed
docs: rewrite README introduction and structure
- Add CI/CD badges for test and release workflows - Rewrite opening paragraph with more engaging copy - Reorganize features into categorized sections with emojis - Simplify Quick Start instructions with clearer steps - Condense Tree View and Auto-Preview sections - Add realistic Supported Syntax example with project context - Improve Installation section with step-by-step instructions - Add Requirements and Contributing sections with icons - More scannable structure with better visual hierarchy
1 parent 16bf229 commit e1febf0

File tree

1 file changed

+69
-67
lines changed

1 file changed

+69
-67
lines changed

README.md

Lines changed: 69 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,105 @@
11
# Markdown Interactive Checkbox Preview
22

3-
A VS Code extension that provides an interactive preview for Markdown checkboxes with live editing capabilities and hierarchical tree view navigation.
3+
[![Tests](https://github.com/GSejas/markdown-checkbox-preview/actions/workflows/test.yml/badge.svg)](https://github.com/GSejas/markdown-checkbox-preview/actions/workflows/test.yml)
4+
[![Release](https://github.com/GSejas/markdown-checkbox-preview/actions/workflows/release.yml/badge.svg)](https://github.com/GSejas/markdown-checkbox-preview/actions/workflows/release.yml)
5+
6+
Transform your Markdown task lists into an interactive, synchronized workspace. Click to toggle checkboxes, navigate with tree views, and track progress—all while your changes sync instantly to your source files.
47

58
![Markdown Preview](media\full-demo-1.0.6_128colors_32colors.gif)
6-
> This extension empowers developers with CodeLens actions to toggle markdown checkboxes.
79

8-
## Features
10+
## ✨ Key Features
911

10-
- **Interactive checkboxes** that can be clicked to toggle state
11-
- **Live sync** - Changes are immediately synced back to the source Markdown file
12-
- **Progress tracking** with visual progress bar and hover over support
13-
- **Hierarchical tree view** in the Explorer sidebar showing all checkboxes organized by headers
14-
- **Status bar integration** showing completion statistics
15-
- **Hover information** - Hover over checkboxes to see status, content, and quick toggle actions
16-
- **CodeLens integration** - See toggle buttons directly above checkbox lines in the editor
17-
- **Smart navigation** - Click headers in preview or tree to jump to source locations
18-
- **Auto-preview toggle** - Automatically open preview when markdown files are opened (status bar button)
12+
### 🎯 Interactive Checkbox Preview
13+
- **One-click toggling** - Click any checkbox in the preview to change its state
14+
- **Real-time sync** - Changes instantly update your Markdown source files
15+
- **Smart navigation** - Click headers to jump directly to source locations
16+
- **Auto-preview mode** - Optional automatic preview opening for markdown files
1917

20-
![Hover over support](media\codelness-demo.gif)
18+
### 📊 Progress Tracking
19+
- **Visual progress bars** showing completion percentages
20+
- **Hover information** with status, content, and quick actions
21+
- **Status bar integration** displaying completion statistics at a glance
22+
23+
### 🌲 Tree View Navigation
24+
- **Hierarchical organization** - Tasks grouped by headers and structure
25+
- **Sidebar integration** - Browse all checkboxes from the Explorer panel
26+
- **Toggle visibility** - Show/hide headers for focused task management
27+
- **One-click updates** - Click any tree item to toggle its state
28+
29+
### 💻 Editor Integration
30+
- **CodeLens actions** - Toggle buttons appear directly above checkbox lines
31+
- **Inline hover cards** - See status and actions without leaving your cursor
32+
- **Seamless workflow** - All features integrate naturally with VS Code
2133

22-
## Usage
34+
## 🚀 Quick Start
2335

24-
### Interactive Preview
25-
1. Open a Markdown file containing checkboxes
26-
2. Use Command Palette: "Open Interactive Checkbox Preview"
36+
### Open Interactive Preview
37+
1. Open any Markdown file with checkboxes
38+
2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac)
39+
3. Search for **"Open Interactive Checkbox Preview"**
2740

2841
![Open Interactive Preview Button](media/open-interactive-preview-button.png)
2942

30-
3. Click checkboxes in the preview to toggle them
31-
4. **Click any header to navigate to that section in the source file**
32-
5. Changes are automatically saved to your file
43+
4. Click checkboxes to toggle them—changes save automatically!
3344

3445
![Real-time Sync](media/markdown-checkbox-preview-real-time-sync.gif)
3546

36-
### Tree View Navigation
47+
### Navigate with Tree View
3748

3849
1. Open a Markdown file with checkboxes
39-
2. Look for "Markdown Checkboxes" section in the Explorer sidebar
40-
3. Browse your tasks organized by headers and hierarchy
41-
4. Click any checkbox in the tree to toggle its state
50+
2. Find **"Markdown Checkboxes"** in the Explorer sidebar
51+
3. Browse your tasks organized by headers
52+
4. Click any checkbox to toggle its state instantly
4253

4354
![Tree View Checkboxes](media/menu-tree-checkboxes.gif)
4455

45-
5. Use the refresh button to update the tree view
46-
6. **Toggle Headers visibility** using the eye icon to show/hide headers in the tree view for focused task management
56+
5. Use the refresh button (↻) to update the view
57+
6. Toggle header visibility (👁) to focus on tasks only
4758

48-
### Hover & CodeLens Support
59+
### Enable Auto-Preview
4960

50-
1. **Hover over checkboxes** in the editor to see:
51-
- Current status (checked/unchecked)
52-
- Task content
53-
- Quick toggle action
54-
- Position and formatting information
61+
Click the **eye icon** in the status bar (bottom-right) to enable auto-preview mode:
62+
- 👁 ✓ = Auto-preview enabled
63+
- 👁 ✗ = Auto-preview disabled
5564

56-
2. **CodeLens actions** appear above checkbox lines showing:
57-
- Toggle buttons with visual icons
58-
- One-click checkbox state changes
59-
- Seamless integration with VS Code's editor
65+
When enabled, previews open automatically for all markdown files.
6066

61-
### Auto-Preview Toggle
62-
63-
1. **Enable auto-preview** using the status bar button (right side of status bar)
64-
- Click the eye icon to toggle auto-preview on/off
65-
- $(eye) $(check) indicates auto-preview is enabled
66-
- $(eye-closed) $(x) indicates auto-preview is disabled
67-
68-
2. **Automatic behavior** when enabled:
69-
- Preview automatically opens when you open markdown files
70-
- Smart panel management prevents duplicate preview windows
71-
- Configuration persists across VS Code sessions
67+
![Hover over support](media\codelness-demo.gif)
7268

73-
3. **Manual override** - You can still manually open previews anytime using the Command Palette
69+
## 📝 Supported Syntax
7470

75-
## Supported Syntax
71+
The extension recognizes standard Markdown checkbox syntax:
7672

77-
- [x] Unchecked task
78-
- [ ] Checked task
79-
- [ ] Nested subtask
80-
8173
```markdown
82-
# Header 1
83-
## Header 2
84-
### Header 3
85-
86-
- [ ] Unchecked task
87-
- [ ] Checked task
88-
- [ ] Nested subtask
89-
- [x] Completed subtask
90-
- [x] Deeply nested task
74+
# Project Tasks
75+
76+
## Development
77+
- [ ] Set up project structure
78+
- [x] Configure build tools
79+
- [x] Install dependencies
80+
- [ ] Set up linting
81+
- [x] ESLint configuration
82+
- [ ] Prettier setup
83+
84+
## Documentation
85+
- [ ] Write README
86+
- [ ] Add API docs
9187
```
9288

93-
## Installation
89+
## 📦 Installation
90+
91+
1. Open VS Code
92+
2. Press `Ctrl+Shift+X` (or `Cmd+Shift+X` on Mac) to open Extensions
93+
3. Search for **"Markdown Checkbox Preview"**
94+
4. Click **Install**
9495

95-
Install from the VS Code Extension Marketplace or use the .vsix file.
96+
Or install directly from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=GSejas.markdown-checkbox-preview).
9697

97-
## Requirements
98+
## 🔧 Requirements
9899

99-
VS Code 1.84.0 or higher
100+
- VS Code 1.84.0 or higher
101+
- No additional dependencies required
100102

101-
## Contributing
103+
## 🤝 Contributing
102104

103105
Contributions are welcome! Please see [CHANGELOG.md](CHANGELOG.md) for version history and development notes.

0 commit comments

Comments
 (0)