@pieceful/ravel-markdown 0.1.0 → 0.1.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 +22 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# @pieceful/ravel-markdown
|
|
2
|
+
|
|
3
|
+
The portable Markdown adapter for Ravel. It extracts explicitly named Ravel
|
|
4
|
+
fences, source ranges, front matter, greedy fragments, and composition
|
|
5
|
+
directives into a Ravel Map.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @pieceful/ravel-markdown
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Its public entry point is `markdownToMap(text, options)`. Use it with
|
|
12
|
+
`@pieceful/ravel-core` to evaluate the resulting map, or with a host package to
|
|
13
|
+
load Markdown from files. The adapter is native ESM and has no filesystem or
|
|
14
|
+
process dependency, so it is suitable for browser, Bun, and Node embedding.
|
|
15
|
+
|
|
16
|
+
Ravel's default Markdown mode leaves ordinary fences alone; primary mode
|
|
17
|
+
requires explicit Ravel classification for every relevant fence.
|
|
18
|
+
|
|
19
|
+
See the [Ravel documentation](https://ravel.jostylr.com/) for the Markdown
|
|
20
|
+
fenced-block profile, directives, and examples.
|
|
21
|
+
|
|
22
|
+
MIT © James Taylor
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pieceful/ravel-markdown",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Markdown profile adapters for Ravel.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "James Taylor",
|
|
8
8
|
"repository": { "type": "git", "url": "git+https://github.com/jostylr/ravel.git", "directory": "packages/markdown" },
|
|
9
9
|
"bugs": { "url": "https://github.com/jostylr/ravel/issues" },
|
|
10
|
-
"homepage": "https://
|
|
10
|
+
"homepage": "https://ravel.jostylr.com/",
|
|
11
11
|
"engines": { "node": ">=22" },
|
|
12
12
|
"keywords": ["ravel", "literate-programming", "markdown"],
|
|
13
13
|
"publishConfig": { "access": "public" },
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
".": "./src/index.js"
|
|
16
16
|
},
|
|
17
17
|
"types": "./src/index.d.ts",
|
|
18
|
-
"files": ["src", "LICENSE"],
|
|
18
|
+
"files": ["src", "README.md", "LICENSE"],
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"mdast-util-from-markdown": "^2.0.3",
|
|
21
21
|
"yaml": "^2.9.0"
|