markedin-parser 0.1.2 → 0.1.3
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 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# markedin-parser
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Markedin (`.mi`) is a file format for both machines and humans. YAML frontmatter + templated Markdown.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
`markedin-parser` parses and renders `.mi` (markedin) files. No framework required. Perfect for file-based agentic systems.
|
|
6
6
|
|
|
7
7
|
Full documentation at [markedin.dev](https://markedin.dev)
|
|
8
8
|
|
|
@@ -17,6 +17,7 @@ npm install markedin-parser
|
|
|
17
17
|
A `.mi` file has YAML frontmatter between `---` delimiters and a Markdown body that renders from it.
|
|
18
18
|
|
|
19
19
|
`task.mi`:
|
|
20
|
+
|
|
20
21
|
```
|
|
21
22
|
---
|
|
22
23
|
task: Implement rate limiting
|
|
@@ -66,7 +67,12 @@ First note: {{notes[0]}}
|
|
|
66
67
|
|
|
67
68
|
```javascript
|
|
68
69
|
const fs = require("fs");
|
|
69
|
-
const {
|
|
70
|
+
const {
|
|
71
|
+
parse,
|
|
72
|
+
render,
|
|
73
|
+
renderHtmlFrag,
|
|
74
|
+
renderHtml,
|
|
75
|
+
} = require("markedin-parser");
|
|
70
76
|
|
|
71
77
|
const source = fs.readFileSync("task.mi", "utf8");
|
|
72
78
|
|
|
@@ -84,8 +90,8 @@ renderHtmlFrag(source);
|
|
|
84
90
|
renderHtml(source);
|
|
85
91
|
|
|
86
92
|
// Embed frontmatter in output
|
|
87
|
-
render(source, { embed: true });
|
|
88
|
-
renderHtml(source, { embed: true });
|
|
93
|
+
render(source, { embed: true }); // appends as HTML comment
|
|
94
|
+
renderHtml(source, { embed: true }); // adds <script> tag in <head>
|
|
89
95
|
```
|
|
90
96
|
|
|
91
97
|
## Markedin Parser API
|
|
@@ -116,7 +122,7 @@ Resolve a dotted/bracketed path against a data object.
|
|
|
116
122
|
|
|
117
123
|
```javascript
|
|
118
124
|
resolvePath(data, "owner.name"); // → 'Dana'
|
|
119
|
-
resolvePath(data, "notes[0]");
|
|
125
|
+
resolvePath(data, "notes[0]"); // → 'Token bucket algorithm chosen over leaky bucket'
|
|
120
126
|
```
|
|
121
127
|
|
|
122
128
|
## License
|