dogfen 2026.1017.0 → 2026.1019.0
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 +15 -7
- package/dist/dogfen.js +60191 -58248
- package/dist/dogfen.min.js +125 -378
- package/dist/dogfen.readonly.min.js +111 -364
- package/package.json +15 -4
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Add the below oneliner to an existing markdown document:
|
|
6
6
|
|
|
7
7
|
```html
|
|
8
|
-
<!
|
|
8
|
+
<!doctype html><script type=module src=https://esm.sh/dogfen></script><textarea style=display:none>
|
|
9
9
|
|
|
10
10
|
# Header 1
|
|
11
11
|
|
|
@@ -32,24 +32,32 @@ Note: this link also includes the `read-only` query parameter.
|
|
|
32
32
|
|
|
33
33
|
It's also possible to generate shareable urls:
|
|
34
34
|
|
|
35
|
-
Example: <https://dogfen.dayl.in?
|
|
35
|
+
Example: <https://dogfen.dayl.in?raw#BYUwNmD2AEDukCcwBMg>
|
|
36
36
|
|
|
37
37
|
Note: this has the typical caveats of embedding data in a url, i.e. for big documents host the data at a public link and use `?href=`
|
|
38
38
|
|
|
39
|
+
## alternative versions
|
|
40
|
+
|
|
41
|
+
### katex
|
|
42
|
+
|
|
43
|
+
If you need support for katex rendering append `/katex` to the src url to get a bundle with katex
|
|
44
|
+
|
|
45
|
+
### readonly
|
|
46
|
+
|
|
47
|
+
If you are using read-only mode and won't need the editor append `/readonly` to the src url to get a bundle without codemirror
|
|
48
|
+
|
|
39
49
|
## converter
|
|
40
50
|
|
|
41
51
|
You could define a shell helper function to quickly convert a markdown doc to a dogfen doc.
|
|
42
52
|
|
|
43
53
|
```sh
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
'<!DOCTYPE html><script src=https://unpkg.dev/dogfen></script><textarea style=display:none>' \
|
|
47
|
-
"$(< "$1")"
|
|
54
|
+
dogfen() {
|
|
55
|
+
(echo '<!doctype html><script type=module src=https://esm.sh/dogfen></script><textarea style=display:none>'; cat "$1")
|
|
48
56
|
}
|
|
49
57
|
```
|
|
50
58
|
|
|
51
59
|
```sh
|
|
52
|
-
|
|
60
|
+
dogfen README.md > README.dogfen.html
|
|
53
61
|
```
|
|
54
62
|
|
|
55
63
|
## related projects
|