Skip to content

Commit f8f0669

Browse files
committed
feat: add screenshot section to README
- Add dedicated screenshots section after Live Demo for immediate visual impact - Create .github/screenshots/ directory for organized image storage - Include placeholders for light mode, dark mode, and mobile screenshots - Add comprehensive screenshot guide with specific instructions - Provide realistic content examples and technical specifications Screenshots will showcase: - Split-view editor/preview layout - Dark/light mode themes - Mobile responsive design - Real markdown content examples This addresses the missing visual element that makes READMEs much more compelling.
1 parent a4eb6be commit f8f0669

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

.github/screenshots/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Screenshots Guide
2+
3+
This directory contains screenshots for the README.md file.
4+
5+
## Required Screenshots:
6+
7+
### 1. `light-mode.png`
8+
- Take a screenshot of the app in light mode
9+
- Show the split-view with editor on left, preview on right
10+
- Include some sample markdown content (like meeting notes)
11+
- Make sure the sidebar with notes list is visible
12+
- Recommended size: 1200x800px or similar
13+
14+
### 2. `dark-mode.png`
15+
- Same layout as light mode but with dark theme enabled
16+
- Use Ctrl+D to toggle to dark mode before taking screenshot
17+
- Show the same or similar content for consistency
18+
- Recommended size: 1200x800px or similar
19+
20+
### 3. `mobile.png`
21+
- Take a screenshot on mobile device or use browser dev tools
22+
- Show how the app adapts to smaller screens
23+
- Demonstrate the responsive design
24+
- Recommended size: 375x812px (iPhone size) or similar mobile dimensions
25+
26+
## Tips for Great Screenshots:
27+
28+
1. **Use realistic content** - Don't use "Lorem ipsum", use actual markdown like:
29+
```markdown
30+
# Project Meeting Notes
31+
32+
## Action Items
33+
- [x] Review design mockups
34+
- [ ] Schedule client call
35+
- [ ] Update timeline
36+
37+
## Code Review
38+
```javascript
39+
const handleSubmit = async (data) => {
40+
return await api.post('/notes', data);
41+
};
42+
```
43+
44+
2. **Show key features**:
45+
- Multiple notes in sidebar
46+
- Live preview working
47+
- Word count in footer
48+
- Clean, professional interface
49+
50+
3. **Good lighting/contrast** - Make sure text is clearly readable
51+
52+
4. **Consistent styling** - Use the same zoom level and window size
53+
54+
## How to Take Screenshots:
55+
56+
1. Open the app at: https://thesolutiondeskandcompany.github.io/markdown-notes/
57+
2. Create some sample notes with realistic content
58+
3. For light mode: Take screenshot
59+
4. Press Ctrl+D to switch to dark mode
60+
5. Take dark mode screenshot
61+
6. Use browser dev tools (F12) to simulate mobile view
62+
7. Take mobile screenshot
63+
64+
Save the files as PNG format with the exact names listed above.

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@
1212

1313
👉 [Try it now!](https://thesolutiondeskandcompany.github.io/markdown-notes/)
1414

15+
## 📸 Screenshots
16+
17+
### Light Mode
18+
![Markdown Notes - Light Mode](.github/screenshots/light-mode.png)
19+
20+
### Dark Mode
21+
![Markdown Notes - Dark Mode](.github/screenshots/dark-mode.png)
22+
23+
### Mobile Responsive
24+
![Markdown Notes - Mobile](.github/screenshots/mobile.png)
25+
1526
---
1627

1728
## ⚡ Quick Start

0 commit comments

Comments
 (0)