Skip to content

Commit d1d60f1

Browse files
rushhiiirushhiii
committed
update
1 parent 21d727c commit d1d60f1

14 files changed

Lines changed: 93 additions & 0 deletions

‎docs/IMAGES_ADDED.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# 🖼️ Images Added to VitePress Documentation
2+
3+
## ✅ Successfully Added Images
4+
5+
All widget documentation pages now include beautiful preview images sourced from your existing `.src` folder!
6+
7+
### 🏠 Homepage
8+
- **Hero Image**: Main mockup wall showcasing all widgets
9+
- **Logo**: Scriptable app icon in navigation
10+
11+
### 📱 Widget Pages
12+
13+
| Widget | Image Added | Source |
14+
|--------|-------------|---------|
15+
| 🌤️ **Weather Widget** | ✅ | `.src/weather/weather_showcase_s.png` |
16+
| ⏰ **Countdown Widget** | ✅ | `.src/countdown/countdow_showcase.png` |
17+
| 📊 **GitHub Stats Widget** | ✅ | `.src/githubstats/githubstats_showcase.png` |
18+
| 🎂 **Birthday Widget** | ✅ | `.src/birthday/birthday_showcase.png` |
19+
| 🌬️ **AQI Widget** | ✅ | `.src/weather/weather_showcase.png` |
20+
| 🕉️ **Hindu Calendar Widget** | ✅ | `.src/hinduclrwear/hinduclrwear_showcase.png` |
21+
| 💭 **Quote Widget** | ✅ | `.src/quotes/quote_showcase_1.png` |
22+
| 📚 **Schedule Widget** | ✅ | `.src/schedule/schedule_showcase_1.png` |
23+
| ⏰ **Time Progress Widget** | ✅ | `.src/timeprogress/timeprogress_showcase.png` |
24+
| 🚗 **Toyota Widget** | ✅ | `.src/toyota/toyota_l.png` |
25+
26+
### 📚 Other Pages
27+
- **Installation Guide**: Hero image showing widget collection
28+
- **Widgets Overview**: Main showcase image
29+
30+
## 🌐 Image Source Strategy
31+
32+
**Using GitHub Raw URLs**: All images are referenced directly from your GitHub repository using raw URLs like:
33+
```
34+
https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/[folder]/[image].png
35+
```
36+
37+
### ✅ Benefits:
38+
- **No Build Issues**: Images don't need to be copied locally
39+
- **Always Up-to-Date**: Images automatically update when you update the source
40+
- **Fast Loading**: GitHub CDN delivers images quickly
41+
- **Version Controlled**: Images are part of your repository
42+
43+
### 🚀 What This Gives You:
44+
45+
1. **Beautiful Documentation**: Every widget now has a visual preview
46+
2. **Professional Look**: Your site looks polished and complete
47+
3. **Better User Experience**: Users can see what widgets look like before installing
48+
4. **Consistent Branding**: All images maintain your design aesthetic
49+
50+
## 🎯 Next Steps
51+
52+
Your documentation now looks amazing with all the widget images! Here's what you can do next:
53+
54+
1. **📱 Test the Site**: Run `npm run docs:dev` and visit `http://localhost:5173`
55+
2. **🌐 Deploy**: Push to GitHub to trigger automatic deployment
56+
3. **📸 Add More Images**: Consider adding setup screenshots, configuration examples
57+
4. **🎨 Customize**: Adjust image sizes or add captions if desired
58+
59+
## 📝 Image Optimization Tips
60+
61+
If you want to optimize the images further:
62+
63+
- **Compress images** for faster loading
64+
- **Add alt text** for accessibility
65+
- **Consider WebP format** for better compression
66+
- **Add loading="lazy"** for performance
67+
68+
Your VitePress documentation site is now visually stunning and ready to impress! 🎉

‎docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ hero:
66
text: "Beautiful Custom Widgets"
77
tagline: "A collection of custom iOS widgets built with Scriptable by rushhiii"
88
image:
9+
src: https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/scriptable_mockup_wall.png
910
alt: Scriptable Widgets
1011
actions:
1112
- theme: brand

‎docs/installation.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Get started with Scriptable iOS Widgets in just a few simple steps!
44

5+
![Installation Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/scriptable_mockup_wall.png)
6+
57
## 📱 Prerequisites
68

79
Before you begin, make sure you have:

‎docs/widgets/aqi-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Monitor air quality in your area with real-time Air Quality Index (AQI) data. Stay informed about pollution levels and make better decisions about outdoor activities.
88

9+
![AQI Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/weather/weather_showcase.png)
10+
911
## ✨ Features
1012

1113
- 🌬️ **Real-time AQI Data**: Current air quality measurements

‎docs/widgets/birthday-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Calculate and display ages with precision down to days, months, and years. Perfect for tracking birthdays, anniversaries, or any significant date milestones.
88

9+
![Birthday Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/birthday/birthday_showcase.png)
10+
911
## ✨ Features
1012

1113
- 🎂 **Precise Age Calculation**: Years, months, and days

‎docs/widgets/countdown-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
A lightweight and customizable countdown widget built using Scriptable, powered by Google Sheets. Track upcoming events like birthdays, anniversaries, or deadlines right from your iOS home screen.
88

9+
![Countdown Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/countdown/countdow_showcase.png)
10+
911
## ✨ Features
1012

1113
- 🗓️ **Dynamic Countdown**: Displays days remaining to events

‎docs/widgets/github-stats-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Display your GitHub coding activity and statistics right on your iOS home screen. Track contributions, repositories, followers, and more with a beautiful, customizable widget.
88

9+
![GitHub Stats Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/githubstats/githubstats_showcase.png)
10+
911
## ✨ Features
1012

1113
- 📈 **Contribution Stats**: Daily, weekly, monthly, and yearly contributions

‎docs/widgets/hindu-calendar-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Stay connected with Hindu festivals, tithis, and auspicious dates. This widget displays the current Hindu calendar date with important festivals and religious observances.
88

9+
![Hindu Calendar Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/hinduclrwear/hinduclrwear_showcase.png)
10+
911
*Documentation coming soon...*
1012

1113
[View Source Code →](https://github.com/rushhiii/Scriptable-IOSWidgets/blob/main/HinduClrWear%20Widget/WearClrAccHindu.js)

‎docs/widgets/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Welcome to the complete collection of Scriptable iOS widgets! Each widget is designed to be beautiful, functional, and easy to set up.
44

5+
![Widgets Showcase](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/scriptable_mockup_wall.png)
6+
57
## 🌟 Popular Widgets
68

79
<div class="widget-grid">

‎docs/widgets/quote-widget.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
Start your day with inspiration! This widget displays daily motivational quotes with beautiful themes and customizable styling options.
88

9+
![Quote Widget Preview](https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/quotes/quote_showcase_1.png)
10+
911
*Documentation coming soon...*
1012

1113
[View Source Code →](https://github.com/rushhiii/Scriptable-IOSWidgets/blob/main/Quote%20Widget/MyQuotes.js)

0 commit comments

Comments
 (0)