chalk-talk 0.0.0-stage → 0.6.1
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/LICENSE +21 -0
- package/README.md +30 -2
- package/assets/player.html +140 -0
- package/package.json +13 -4
- package/player.js +125 -0
- package/scripts/browser.mjs +47 -0
- package/scripts/build.mjs +79 -0
- package/scripts/contract.mjs +724 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ruinosus
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,31 @@
|
|
|
1
|
-
#
|
|
1
|
+
# chalk-talk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Hand-drawn lessons that draw themselves, from a small JSON **recipe** — the player behind the
|
|
4
|
+
[chalk-talk skill](https://github.com/ruinosus/chalk-talk). See the [gallery](https://ruinosus.github.io/chalk-talk/).
|
|
5
|
+
|
|
6
|
+
## In a web page (or a claude.ai artifact)
|
|
7
|
+
|
|
8
|
+
```html
|
|
9
|
+
<!doctype html>
|
|
10
|
+
<meta charset="utf-8">
|
|
11
|
+
<title>My lesson</title>
|
|
12
|
+
<script type="application/json" id="chalk-recipe">{ "id": "my-lesson", "title": "…", "width": 900, "height": 560, "steps": [ … ] }</script>
|
|
13
|
+
<script src="https://cdn.jsdelivr.net/npm/chalk-talk@0.6.1/player.js"></script>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The player builds the page around the recipe — chapters, Next / Back, values to move, the check, downloads — and needs
|
|
17
|
+
nothing else. A course is `{ "course": "Title", "lessons": [recipe, recipe, …] }`, each lesson opened with
|
|
18
|
+
`?lesson=n`.
|
|
19
|
+
|
|
20
|
+
## From the command line
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
npx chalk-talk lesson.json # checks the recipe and writes lesson.html
|
|
24
|
+
npx chalk-talk one.json two.json --out course.html --title "The course"
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
It checks the recipe contract, builds one HTML file that opens offline and, when Chrome, Chromium or Edge is
|
|
28
|
+
installed, reviews the drawing (nothing off the paper, no text over text). How to write a recipe:
|
|
29
|
+
[recipe.md](https://github.com/ruinosus/chalk-talk/blob/main/skills/chalk-talk/references/recipe.md).
|
|
30
|
+
|
|
31
|
+
MIT. Strokes by Rough.js (MIT); fonts Caveat and Shantell Sans (SIL Open Font License), embedded.
|