Skip to content

Commit 4295c26

Browse files
committed
Update check-files.sh
1 parent eb64f93 commit 4295c26

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3355
-630
lines changed

.assets/favicon_sr.png

136 KB
Loading

.assets/favicon_sr_raw.png

76 KB
Loading

Web Docs/docs/IMAGES_ADDED.md

Lines changed: 31 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,46 @@
1-
# 🖼️ Images Added to VitePress Documentation
1+
# 🖼️ Media Asset Reference
22

3-
## ✅ Successfully Added Images
3+
The widgets rely on a consistent set of showcase images stored inside `.src/`. This page documents which image belongs to which guide so you can maintain them easily while migrating to GitBook.
44

5-
All widget documentation pages now include beautiful preview images sourced from your existing `.src` folder!
5+
## Primary Visuals
66

7-
### 🏠 Homepage
8-
- **Hero Image**: Main mockup wall showcasing all widgets
9-
- **Logo**: Scriptable app icon in navigation
7+
- **Library hero**: `.assets/scriptable_mockup_wall.png`
8+
- **App icon**: `.assets/scriptable_icon.png`
109

11-
### 📱 Widget Pages
10+
## Widget Previews
1211

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` |
12+
| Widget | Image | Relative Path |
13+
| --- | --- | --- |
14+
| 🌤️ Weather | `weather_showcase_s.png` | `.assets/weather/weather_showcase_s.png` |
15+
| ⏰ Countdown | `countdow_showcase.png` | `.assets/countdown/countdow_showcase.png` |
16+
| 📊 GitHub Stats | `githubstats_showcase.png` | `.assets/githubstats/githubstats_showcase.png` |
17+
| 🎂 Birthday | `birthday_showcase.png` | `.assets/birthday/birthday_showcase.png` |
18+
| 🌬️ AQI | `openweatheraqi_showcase.png` | `.assets/aqi/openweatheraqi_showcase.png` |
19+
| 🕉️ Hindu Calendar | `hinduclrwear_showcase.png` | `.assets/hinduclrwear/hinduclrwear_showcase.png` |
20+
| 💭 Quote | `quote_showcase_1.png` | `.assets/quotes/quote_showcase_1.png` |
21+
| 📚 Schedule | `schedule_showcase_1.png` | `.assets/schedule/schedule_showcase_1.png` |
22+
| Time Progress | `timeprogress_showcase.png` | `.assets/timeprogress/timeprogress_showcase.png` |
23+
| 🚗 Toyota | `toyota_l.png` | `.assets/toyota/toyota_l.png` |
2524

26-
### 📚 Other Pages
27-
- **Installation Guide**: Hero image showing widget collection
28-
- **Widgets Overview**: Main showcase image
25+
## Referencing Images in GitBook
2926

30-
## 🌐 Image Source Strategy
27+
Use GitHub raw links so GitBook always fetches the latest asset:
3128

32-
**Using GitHub Raw URLs**: All images are referenced directly from your GitHub repository using raw URLs like:
3329
```
34-
https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.src/[folder]/[image].png
30+
https://raw.githubusercontent.com/rushhiii/Scriptable-IOSWidgets/main/.assets/<folder>/<file>.png
3531
```
3632

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
33+
Benefits:
4234

43-
### 🚀 What This Gives You:
35+
- ✅ No manual uploads—images stay version controlled with the code.
36+
- ✅ Fast delivery via GitHub's CDN.
37+
- ✅ Automatic updates when assets change.
4438

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
39+
## Maintenance Tips
4940

50-
## 🎯 Next Steps
41+
1. **Keep alt text descriptive** so GitBook pages remain accessible.
42+
2. **Compress PNGs/WebP** before committing to keep pages lightweight.
43+
3. **Batch new assets** in `.assets/<widget>/` to stay organized.
44+
4. **Document additions here** whenever you add or rename an image.
5145

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! 🎉
46+
With this reference you can cross-check every page before enabling GitHub ↔ GitBook sync and ensure all visuals resolve correctly.

Web Docs/docs/SUMMARY.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Summary
2+
3+
* [Welcome](index.md)
4+
* [Installation Guide](installation.md)
5+
* [Contributing](contributing.md)
6+
* [Media Asset Reference](IMAGES_ADDED.md)
7+
* [Widget Library](widgets/index.md)
8+
* [AQI Widget](widgets/aqi-widget.md)
9+
* [Birthday Widget](widgets/birthday-widget.md)
10+
* [Countdown Widget](widgets/countdown-widget.md)
11+
* [GitHub Stats Widget](widgets/github-stats-widget.md)
12+
* [Hindu Calendar Widget](widgets/hindu-calendar-widget.md)
13+
* [Quote Widget](widgets/quote-widget.md)
14+
* [Schedule Widget](widgets/schedule-widget.md)
15+
* [Time Progress Widget](widgets/time-progress-widget.md)
16+
* [Toyota Widget](widgets/toyota-widget.md)
17+
* [Weather Widget](widgets/weather-widget.md)

0 commit comments

Comments
 (0)