Skip to content

Commit 1a50bcb

Browse files
committed
docs: update README badges and wording
1 parent d217790 commit 1a50bcb

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Markdown-LD Knowledge Bank
22

3+
[![PR validation](https://github.com/managedcode/markdown-ld-kb/actions/workflows/validation.yml/badge.svg)](https://github.com/managedcode/markdown-ld-kb/actions/workflows/validation.yml)
4+
[![Release](https://github.com/managedcode/markdown-ld-kb/actions/workflows/release.yml/badge.svg)](https://github.com/managedcode/markdown-ld-kb/actions/workflows/release.yml)
5+
[![CodeQL](https://github.com/managedcode/markdown-ld-kb/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/managedcode/markdown-ld-kb/actions/workflows/codeql-analysis.yml)
6+
[![NuGet](https://img.shields.io/nuget/v/ManagedCode.MarkdownLd.Kb.svg?logo=nuget)](https://www.nuget.org/packages/ManagedCode.MarkdownLd.Kb)
7+
[![NuGet downloads](https://img.shields.io/nuget/dt/ManagedCode.MarkdownLd.Kb.svg?logo=nuget)](https://www.nuget.org/packages/ManagedCode.MarkdownLd.Kb)
8+
[![GitHub release](https://img.shields.io/github/v/release/managedcode/markdown-ld-kb?include_prereleases&logo=github)](https://github.com/managedcode/markdown-ld-kb/releases)
9+
[![.NET 10](https://img.shields.io/badge/.NET-10.0-512BD4?logo=dotnet)](https://dotnet.microsoft.com/)
10+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
11+
312
Markdown-LD Knowledge Bank is a .NET 10 library for turning Markdown knowledge-base files into an in-memory RDF graph that can be searched, queried with read-only SPARQL, exported as RDF, and rendered as a diagram.
413

514
It ports the core idea from [lqdev/markdown-ld-kb](https://github.com/lqdev/markdown-ld-kb) into a C# library package. The runtime is local and in-memory: no localhost server, no Azure Functions host, no database server, and no hosted graph service are required.
@@ -148,7 +157,7 @@ You do not need to pass a base URI for normal use. Document identity is resolved
148157
- the file path, normalized the same way as the upstream project: `content/notes/rdf.md` becomes a stable document IRI
149158
- the generated inline document path when `BuildFromMarkdownAsync` is called without a path
150159

151-
The library uses `urn:managedcode:markdown-ld-kb:/` as an internal default base URI only to create valid RDF IRIs when the Markdown does not provide a canonical URL. Pass `new MarkdownKnowledgePipeline(new Uri("https://your-domain/"))` only when you want generated document/entity IRIs to live under your own domain.
160+
The library uses `urn:managedcode:markdown-ld-kb:/` as an internal default base URI only to create valid RDF IRIs when the source does not provide `KnowledgeDocumentConversionOptions.CanonicalUri`. Pass `new MarkdownKnowledgePipeline(new Uri("https://your-domain/"))` only when you want generated document/entity IRIs to live under your own domain.
152161

153162
## Optional AI Extraction
154163

@@ -307,7 +316,7 @@ var rows = await shared.Graph.SearchAsync("rdf");
307316
| `KnowledgeGraph` | In-memory dotNetRDF graph with query, search, export, and merge. |
308317
| `KnowledgeGraphSnapshot` | Immutable view with `Nodes` (`KnowledgeGraphNode`) and `Edges` (`KnowledgeGraphEdge`). |
309318
| `MarkdownDocument` | Pipeline parsed document: `FrontMatter`, `Body`, and `Sections`. |
310-
| `MarkdownFrontMatter` | Typed access to YAML front matter fields. |
319+
| `MarkdownFrontMatter` | Typed front matter model used by the low-level Markdown parser. |
311320
| `KnowledgeExtractionResult` | Merged collection of `KnowledgeEntityFact` and `KnowledgeAssertionFact`. |
312321
| `SparqlQueryResult` | Query result with `Variables` and `Rows` of `SparqlRow`. |
313322
| `KnowledgeSourceDocumentConverter` | Converts files and directories into pipeline-ready source documents. |
@@ -344,7 +353,7 @@ Recognized front matter keys:
344353
| `author` | `schema:author` | string or list |
345354
| `tags` / `keywords` | `schema:keywords` | list |
346355
| `about` | `schema:about` | list |
347-
| `canonicalUrl` / `canonical_url` | root parser document identity; use `KnowledgeDocumentConversionOptions.CanonicalUri` for pipeline identity | string (URL) |
356+
| `canonicalUrl` / `canonical_url` | low-level Markdown parser document identity; use `KnowledgeDocumentConversionOptions.CanonicalUri` for pipeline identity | string (URL) |
348357
| `entity_hints` / `entityHints` | entity hints | list of `{label, type, sameAs}` |
349358

350359
Optional advanced predicate forms:

0 commit comments

Comments
 (0)