@longform/async 0.1.1 → 0.2.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/README.md +9 -3
- package/dist/api-metadata.json +1202 -0
- package/dist/async.d.ts +626 -0
- package/dist/longform.cjs +11 -9
- package/dist/longform.cjs.map +1 -1
- package/dist/longform.d.ts +5 -5
- package/dist/longform.js +11 -9
- package/dist/longform.js.br +0 -0
- package/dist/longform.js.gz +0 -0
- package/dist/longform.js.map +1 -1
- package/dist/longform.min.js +1 -1
- package/dist/longform.min.js.br +0 -0
- package/dist/longform.min.js.gz +0 -0
- package/dist/longform.min.js.map +1 -1
- package/dist/mod.d.ts +563 -2
- package/dist/types.d.ts +29 -6
- package/lib/longform.ts +13 -10
- package/lib/types.ts +33 -6
- package/package.json +13 -4
package/README.md
CHANGED
|
@@ -11,6 +11,9 @@ parser implementations. Both the Longform language and parsers are a work in pro
|
|
|
11
11
|
Read more about the Longform language in <a href=https://longform.occultist.dev>
|
|
12
12
|
the Longform Markup Language</a> specification document.
|
|
13
13
|
|
|
14
|
+
If you wish to test out Longform, <a href=https://stat.occultist.dev target=_blank>Stat</a>
|
|
15
|
+
is a simple and extendable framework for building static websites.
|
|
16
|
+
|
|
14
17
|
|
|
15
18
|
## When to use not use these parsers
|
|
16
19
|
|
|
@@ -32,12 +35,12 @@ parsers are not considered stable, keep that in mind if you decide to use them.
|
|
|
32
35
|
## Install
|
|
33
36
|
|
|
34
37
|
```
|
|
35
|
-
pnpm
|
|
36
|
-
deno
|
|
38
|
+
pnpm add @longform/async
|
|
39
|
+
deno add jsr:@longform/async
|
|
37
40
|
|
|
38
41
|
# the sync version is not the latest and is not on JSR.
|
|
39
42
|
# It is also missing features
|
|
40
|
-
pnpm
|
|
43
|
+
pnpm add @longform/longform@=0.0.6
|
|
41
44
|
```
|
|
42
45
|
|
|
43
46
|
## Usage
|
|
@@ -157,6 +160,9 @@ developed.
|
|
|
157
160
|
The async parser supports custom directives with a number of hooks to work
|
|
158
161
|
for different locations in the document structure.
|
|
159
162
|
|
|
163
|
+
Inline directives (using the <code>@{foo:bar:: Args...}</code>) syntax is not
|
|
164
|
+
yet supported.
|
|
165
|
+
|
|
160
166
|
See the docs on the <a href=https://jsr.io/@longform/async/doc/~/Directive>
|
|
161
167
|
Directive</a> type for a description of the hooks available to directives.
|
|
162
168
|
Directives are passed to the Longform parser as an object.
|