mdld-parse 0.2.3 → 0.2.5

package/README.md

@@ -1,15 +1,14 @@
 # MD-LD Parse v0.2
 
-**Markdown-Linked Data (MD-LD)** — a deterministic, streaming-friendly RDF authoring format that extends Markdown with explicit `{}` annotations.
+**Markdown-Linked Data (MD-LD)** — a deterministic, streaming-friendly RDF authoring format that extends Markdown with explicit `{...}` annotations.
 
 [![NPM](https://img.shields.io/npm/v/mdld-parse)](https://www.npmjs.com/package/mdld-parse)
-[![License](https://img.shields.io/npm/l/mdld-parse)](https://github.com/mdld-js/mdld-parse)
 
-[Documentation](https://mdld.js.org) | [Specification](https://mdld.js.org/spec) | [Playground](https://mdld.js.org/playground)
+[Documentation](https://mdld.js.org) | [Repository](https://github.com/davay42/mdld-parse) | [Playground](https://mdld.js.org/playground)
 
 ## What is MD-LD?
 
-MD-LD allows you to author RDF graphs directly in Markdown using explicit `{}` annotations:
+MD-LD allows you to author RDF graphs directly in Markdown using explicit `{...}` annotations:
 
 ```markdown
 # Apollo 11 {=ex:apollo11 .SpaceMission}
@@ -32,8 +31,8 @@ ex:apollo11 a schema:SpaceMission ;
 
 MD-LD v0.2 provides strict semantic guarantees:
 
-1. **CommonMark-preserving** — Removing `{}` yields valid Markdown
-2. **Explicit semantics** — Every quad originates from explicit `{}`
+1. **CommonMark-preserving** — Removing `{...}` yields valid Markdown
+2. **Explicit semantics** — Every quad originates from explicit `{...}`
 3. **Single-pass parsing** — Streaming-friendly, deterministic
 4. **No blank nodes** — All subjects are stable IRIs
 5. **Complete traceability** — Every quad maps to source location
@@ -140,7 +139,7 @@ Links create relationships (use `?` prefix):
 ```markdown
 # Mission {=ex:apollo11}
 
-[NASA](ex:nasa) {?organizer}
+[NASA] {=ex:nasa ?organizer}
 ```
 
 ```turtle
@@ -149,12 +148,12 @@ ex:apollo11 schema:organizer ex:nasa .
 
 ### Resource Declaration
 
-Declare resources inline with `(=iri)`:
+Declare resources inline with `{=iri}`:
 
 ```markdown
 # Mission {=ex:apollo11}
 
-[Neil Armstrong](=ex:armstrong) {?commander .Person}
+[Neil Armstrong] {=ex:armstrong ?commander .Person}
 ```
 
 ```turtle
@@ -171,8 +170,8 @@ Lists require explicit subjects per item:
 
 Ingredients: {?ingredient .Ingredient}
 
-- [Flour](=ex:flour) {name}
-- [Water](=ex:water) {name}
+- Flour {=ex:flour name}
+- Water {=ex:water name}
 ```
 
 ```turtle
@@ -219,7 +218,7 @@ Reverse the relationship direction:
 
 Part of: {^?hasPart}
 
-- [Book](=ex:book) {}
+- Book {=ex:book}
 ```
 
 ```turtle
@@ -294,7 +293,7 @@ Apply RDF changes back to markdown with proper positioning.
 **Returns:** `{ text, origin }`
 
 - `text` — Updated markdown
-- `origin` — Updated origin tracking
+- `origin` — Updated origin tracking vacant slots
 
 **Example:**
 
@@ -331,21 +330,17 @@ console.log(updated.text);
 Only specific markdown elements can carry semantic values:
 
 **Inline:**
-- `[text]` — span with annotation
-- `[text](url)` — link to external resource
-- `[text](=iri)` — inline resource declaration
+- `[text] {...}` — span with annotation
+- `[text](url) {...}` — link to external resource
+- `[text] {...}` — inline resource declaration
+- `![alt text](image.png) {...}` — embedding with annotation
 
 **Block:**
 - Headings (`# Title`)
-- List items (`- item`)
+- List items (`- item`, `1. item`) (single-level)
 - Blockquotes (`> quote`)
 - Code blocks (` ```lang `)
 
-**Non-carriers:**
-- Plain paragraphs without `[...]`
-- Images (future)
-- Tables (future)
-
 ## Architecture
 
 ### Design Principles
@@ -383,12 +378,12 @@ MD-LD explicitly forbids to ensure deterministic parsing:
 
 Attendees: {?attendee}
 
-- [Alice](=urn:person:alice) {name}
-- [Bob](=urn:person:bob) {name}
+- Alice {=urn:person:alice name}
+- Bob {=urn:person:bob name}
 
 Action items: {?actionItem}
 
-- [Review proposal](=urn:task:1) {name}
+- Review proposal {=urn:task:1 name}
 ```
 
 ### Developer Documentation
@@ -401,7 +396,7 @@ Action items: {?actionItem}
 
 Example:
 
-```bash {=api:/users/:id/example .CodeExample programmingLanguage}
+```bash {=api:/users/:id#example .CodeExample text}
 curl https://api.example.com/users/123
 ```
 ````
@@ -412,7 +407,7 @@ curl https://api.example.com/users/123
 # Paper {=doi:10.1234/example .ScholarlyArticle}
 
 [Semantic Web] {about}
-[Alice Johnson](=orcid:0000-0001-2345-6789) {?author .Person}
+[Alice Johnson] {=orcid:0000-0001-2345-6789 author}
 [2024-01] {datePublished ^^xsd:gYearMonth}
 
 > This paper explores semantic markup in Markdown. {abstract @en}