@sheetxl/workbook-templates 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -5
- package/dist/contents.json +12 -0
- package/dist/workbook-templates/contents.json +8 -4
- package/dist/workbook-templates/finance/loan-calculator.dark.webp +0 -0
- package/dist/workbook-templates/finance/loan-calculator.webp +0 -0
- package/dist/workbook-templates/finance/monthly-budget.dark.webp +0 -0
- package/dist/workbook-templates/finance/monthly-budget.webp +0 -0
- package/dist/workbook-templates/lifestyle/habit-tracker.dark.webp +0 -0
- package/dist/workbook-templates/lifestyle/habit-tracker.webp +0 -0
- package/dist/workbook-templates/project-management/simple-task-list.dark.webp +0 -0
- package/dist/workbook-templates/project-management/simple-task-list.webp +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,10 +28,12 @@ validates the workbook, builds the index and publishes it.
|
|
|
28
28
|
- **The folder is the category.** Use an existing folder, or create a new one. There is one level
|
|
29
29
|
only; an `.xlsx` directly in `templates/` fails the build.
|
|
30
30
|
- **Thumbnails come from CI.** You do not need to make one. CI opens each template in the pinned
|
|
31
|
-
SheetXL studio (`render/`) and photographs its first screen
|
|
32
|
-
|
|
31
|
+
SheetXL studio (`render/`) and photographs its first screen twice: once light, and once dark with
|
|
32
|
+
the dark grid on. The headers and the selection are left out. A hand-made `<name>.png` (or
|
|
33
|
+
`<name>.dark.png`) beside the template is used instead, for a template whose first screen is not
|
|
34
|
+
its best.
|
|
33
35
|
|
|
34
|
-
To check a template before you push, run `npm install` and `npm run build`. To see its
|
|
36
|
+
To check a template before you push, run `npm install` and `npm run build`. To see its thumbnails,
|
|
35
37
|
run `npx playwright install chromium` once, then `npm run thumbnails` before the build; the images
|
|
36
38
|
land in `.thumbnails/`.
|
|
37
39
|
|
|
@@ -46,7 +48,8 @@ templates/
|
|
|
46
48
|
_category.json optional: { "title", "description", "order", "icon" }
|
|
47
49
|
<name>.xlsx a template
|
|
48
50
|
<name>.png optional hand-made thumbnail
|
|
49
|
-
|
|
51
|
+
<name>.dark.png optional hand-made dark thumbnail
|
|
52
|
+
config/thumbnails.ts renders .thumbnails/<category>/<name>[.dark].webp for each template
|
|
50
53
|
config/build.ts validates every template, then writes dist/
|
|
51
54
|
render/ the page that renders one template for its thumbnail
|
|
52
55
|
```
|
|
@@ -62,6 +65,7 @@ dist/contents.json root listing of every file and
|
|
|
62
65
|
dist/workbook-templates/contents.json the catalog
|
|
63
66
|
dist/workbook-templates/<category>/<name>.xlsx
|
|
64
67
|
dist/workbook-templates/<category>/<name>.webp the rendered thumbnail, or a hand-made .png
|
|
68
|
+
dist/workbook-templates/<category>/<name>.dark.webp the same on the dark grid
|
|
65
69
|
```
|
|
66
70
|
|
|
67
71
|
The catalog looks like this. Entry paths are relative to `dist/workbook-templates/`.
|
|
@@ -75,7 +79,10 @@ The catalog looks like this. Entry paths are relative to `dist/workbook-template
|
|
|
75
79
|
"categories": [{ "id": "finance", "title": "Finance", "description": "..." }]
|
|
76
80
|
},
|
|
77
81
|
"entries": [
|
|
78
|
-
{
|
|
82
|
+
{
|
|
83
|
+
"path": "finance/loan-calculator.xlsx", "category": "finance", "title": "Loan Calculator",
|
|
84
|
+
"thumbnail": "finance/loan-calculator.webp", "thumbnailDark": "finance/loan-calculator.dark.webp"
|
|
85
|
+
}
|
|
79
86
|
]
|
|
80
87
|
}
|
|
81
88
|
```
|
package/dist/contents.json
CHANGED
|
@@ -3,24 +3,36 @@
|
|
|
3
3
|
{
|
|
4
4
|
"path": "workbook-templates/contents.json"
|
|
5
5
|
},
|
|
6
|
+
{
|
|
7
|
+
"path": "workbook-templates/finance/loan-calculator.dark.webp"
|
|
8
|
+
},
|
|
6
9
|
{
|
|
7
10
|
"path": "workbook-templates/finance/loan-calculator.webp"
|
|
8
11
|
},
|
|
9
12
|
{
|
|
10
13
|
"path": "workbook-templates/finance/loan-calculator.xlsx"
|
|
11
14
|
},
|
|
15
|
+
{
|
|
16
|
+
"path": "workbook-templates/finance/monthly-budget.dark.webp"
|
|
17
|
+
},
|
|
12
18
|
{
|
|
13
19
|
"path": "workbook-templates/finance/monthly-budget.webp"
|
|
14
20
|
},
|
|
15
21
|
{
|
|
16
22
|
"path": "workbook-templates/finance/monthly-budget.xlsx"
|
|
17
23
|
},
|
|
24
|
+
{
|
|
25
|
+
"path": "workbook-templates/lifestyle/habit-tracker.dark.webp"
|
|
26
|
+
},
|
|
18
27
|
{
|
|
19
28
|
"path": "workbook-templates/lifestyle/habit-tracker.webp"
|
|
20
29
|
},
|
|
21
30
|
{
|
|
22
31
|
"path": "workbook-templates/lifestyle/habit-tracker.xlsx"
|
|
23
32
|
},
|
|
33
|
+
{
|
|
34
|
+
"path": "workbook-templates/project-management/simple-task-list.dark.webp"
|
|
35
|
+
},
|
|
24
36
|
{
|
|
25
37
|
"path": "workbook-templates/project-management/simple-task-list.webp"
|
|
26
38
|
},
|
|
@@ -26,25 +26,29 @@
|
|
|
26
26
|
"path": "finance/loan-calculator.xlsx",
|
|
27
27
|
"category": "finance",
|
|
28
28
|
"title": "Loan Calculator",
|
|
29
|
-
"thumbnail": "finance/loan-calculator.webp"
|
|
29
|
+
"thumbnail": "finance/loan-calculator.webp",
|
|
30
|
+
"thumbnailDark": "finance/loan-calculator.dark.webp"
|
|
30
31
|
},
|
|
31
32
|
{
|
|
32
33
|
"path": "finance/monthly-budget.xlsx",
|
|
33
34
|
"category": "finance",
|
|
34
35
|
"title": "Monthly Budget",
|
|
35
|
-
"thumbnail": "finance/monthly-budget.webp"
|
|
36
|
+
"thumbnail": "finance/monthly-budget.webp",
|
|
37
|
+
"thumbnailDark": "finance/monthly-budget.dark.webp"
|
|
36
38
|
},
|
|
37
39
|
{
|
|
38
40
|
"path": "lifestyle/habit-tracker.xlsx",
|
|
39
41
|
"category": "lifestyle",
|
|
40
42
|
"title": "Habit Tracker",
|
|
41
|
-
"thumbnail": "lifestyle/habit-tracker.webp"
|
|
43
|
+
"thumbnail": "lifestyle/habit-tracker.webp",
|
|
44
|
+
"thumbnailDark": "lifestyle/habit-tracker.dark.webp"
|
|
42
45
|
},
|
|
43
46
|
{
|
|
44
47
|
"path": "project-management/simple-task-list.xlsx",
|
|
45
48
|
"category": "project-management",
|
|
46
49
|
"title": "Simple Task List",
|
|
47
|
-
"thumbnail": "project-management/simple-task-list.webp"
|
|
50
|
+
"thumbnail": "project-management/simple-task-list.webp",
|
|
51
|
+
"thumbnailDark": "project-management/simple-task-list.dark.webp"
|
|
48
52
|
}
|
|
49
53
|
]
|
|
50
54
|
}
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|