build pipeline

Author: schmichri

.github/workflows/prerelease.yml

@@ -18,7 +18,7 @@ jobs:
           node-version: '24'
 
       - name: Install dependencies
-        run: cd lib && npm ci
+        run: cd lib && npm install
 
       - name: Build package
         run: cd lib && npm run build

.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
-        run: cd lib && npm ci
+        run: cd lib && npm install
 
       - name: Get version from package.json
         id: package-version

lib/README.md

@@ -4,4 +4,199 @@ Transform Markdown to JSON-LD with Advanced Table & Annotation Support
 
 This is the npm package for the [json-ld-markdown](https://github.com/iunera/json-ld-markdown) project.
 
-For full documentation, please see the [main repository README](https://github.com/iunera/json-ld-markdown).
+## Installation
+
+```bash
+npm install markdown-to-json-ld
+```
+
+## Usage
+
+The library provides two main classes:
+- `EnhancedMarkdownParser`: Parses Markdown content and extracts various components
+- `JsonLDTransformer`: Transforms the parsed Markdown data into JSON-LD
+
+### Basic Usage
+
+```javascript
+import { JsonLDTransformer } from 'markdown-to-json-ld';
+
+// Your Markdown content
+const markdownContent = `---
+title: My Article
+type: Article
+schema: https://schema.org
+date: 2023-08-15
+author: John Doe
+---
+
+# My Article
+
+This is the content of my article.`;
+
+// Configuration options
+const config = {
+  baseUrl: 'https://example.com',
+  slug: 'my-article',
+  descriptionLength: 200,
+  type: 'Article',
+  date: '2023-08-15',
+  author: ['John Doe'],
+  publisher: {
+    name: 'Example Publisher',
+    url: 'https://example.com'
+  },
+  keywords: ['example', 'article'],
+  categories: ['Technology']
+};
+
+// Transform Markdown to JSON-LD
+const jsonLd = JsonLDTransformer.transform(markdownContent, config);
+
+// Output the JSON-LD
+console.log(JSON.stringify(jsonLd, null, 2));
+```
+
+### Configuration Options
+
+The `transform` method accepts the following configuration options:
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `baseUrl` | string | Base URL for the article | `'https://example.com'` |
+| `slug` | string | Slug for the article URL | `''` |
+| `descriptionLength` | number | Maximum length for the description | `200` |
+| `type` | string | Type of the article (e.g., 'Article', 'NewsArticle') | `'Article'` |
+| `date` | string | Publication date in ISO format | Current date |
+| `author` | array | Array of author names | `[]` |
+| `publisher` | object | Publisher information | `{}` |
+| `keywords` | array | Keywords for the article | `[]` |
+| `categories` | array | Categories for the article | `[]` |
+
+### Advanced Features
+
+#### YAML Front Matter
+
+The library supports YAML front matter for defining metadata:
+
+```markdown
+---
+title: My Article
+type: Article
+schema: https://schema.org
+date: 2023-08-15
+author: John Doe
+publisher.name: Example Publisher
+publisher.url: https://example.com
+slug: my-article
+keywords: [example, article]
+categories: [Technology]
+---
+
+# My Article
+
+Content here...
+```
+
+#### FAQ Sections
+
+FAQ sections are automatically detected and transformed into a separate `FAQPage` JSON-LD object:
+
+```markdown
+## Frequently Asked Questions
+
+### What is this?
+This is an example.
+
+### How does it work?
+It works like this...
+```
+
+#### Tables
+
+Markdown tables are automatically detected and transformed into `Table` or `Dataset` JSON-LD objects:
+
+```markdown
+| Name | Price | Description |
+|------|-------|-------------|
+| Item 1 | $10 | Description 1 |
+| Item 2 | $20 | Description 2 |
+```
+
+#### Lists
+
+Ordered and unordered lists are transformed into `ItemList` JSON-LD objects:
+
+```markdown
+- Item 1
+- Item 2
+- Item 3
+```
+
+#### Links
+
+Links are transformed into appropriate JSON-LD objects based on their URL:
+
+```markdown
+[Example](https://example.com)
+[GitHub Repository](https://github.com/example/repo)
+[YouTube Video](https://youtube.com/watch?v=123456)
+```
+
+#### Multiple Types
+
+You can define multiple JSON-LD types in a single Markdown file using the `---` separator:
+
+```markdown
+---
+type: Article
+schema: https://schema.org
+---
+
+# My Article
+
+Content here...
+
+---
+type: Document
+schema: http://purl.org/dc/terms/
+---
+
+# Metadata
+
+Additional metadata here...
+```
+
+## Examples
+
+For more examples, see the [example-articles](https://github.com/iunera/json-ld-markdown/tree/main/example-articles) directory in the main repository.
+
+## API Reference
+
+### EnhancedMarkdownParser
+
+The `EnhancedMarkdownParser` class provides methods for parsing Markdown content:
+
+- `extractMetadata(content)`: Extracts metadata from YAML front matter
+- `extractContext(content)`: Extracts the JSON-LD context
+- `extractTables(content)`: Extracts tables from the content
+- `extractLists(content)`: Extracts lists from the content
+- `extractLinks(content, articleUrl)`: Extracts links from the content
+- `extractAnnotations(content)`: Extracts annotations from the content
+- `extractTitle(content)`: Extracts the title from the content
+- `extractDescription(content, maxLength)`: Extracts the description from the content
+- `extractArticleBody(content)`: Extracts the article body from the content
+- `extractSections(content)`: Extracts sections from the content
+- `extractFaqQuestions(content)`: Extracts FAQ questions from the content
+
+### JsonLDTransformer
+
+The `JsonLDTransformer` class provides methods for transforming Markdown to JSON-LD:
+
+- `transform(markdownContent, config)`: Transforms Markdown content to JSON-LD
+- `processAuthors(authors, articleUrl)`: Processes author information
+- `processPublisher(publisher)`: Processes publisher information
+
+## For more information
+
+For full documentation, please see the [main repository README](https://github.com/iunera/json-ld-markdown).