obby-parser 0.1.0 → 0.1.2

package/README.md

@@ -1,39 +1,41 @@
-# Obsi-Parser
-A helper package for converting markdown into html.
+# Obby-Parser
 
-Supports obsidian style links and returns translated html and links to then be used on something like my personal website
+A simple TypeScript library for parsing Obsidian-style markdown. It converts `[[wikilinks]]` to HTML anchor tags and collects all unique links.
 
-# c-addon-example
+## Features
 
-Minimal example npm package showing how to call C code from Node using an N-API native addon.
+- Converts `[[Page Name]]` to `<a href="route/Page-Name">Page Name</a>`
+- Collects all wikilinks in a Set
+- Supports standard markdown formatting via [markdown-it](https://github.com/markdown-it/markdown-it)
 
-## Requirements
-- Node.js (LTS recommended)
-- Python 3
-- Native build tools (gcc/clang/Xcode/Visual Studio Build Tools)
-
-## Build
-Install dependencies and build the addon:
+## Installation
 
 ```bash
-npm install
-# (node-gyp runs via the install script and builds the addon)
+npm install obsi-parser
 ```
 
-Or explicitly:
+## Usage
 
-```bash
-npm run build
-```
+```typescript
+import { parseMarkdown } from 'obsi-parser';
 
-## Usage
+const markdown = "This references [[My Page]] and also **bold** text.";
+const result = parseMarkdown(markdown, "pages/");
 
-```js
-const { add } = require('c-addon-example');
-console.log(add(2, 3)); // 5
+console.log(result.html);      // HTML output with anchor tags
+console.log(result.links_set); // Set { "My Page" }
 ```
 
-## Notes
-- To link an external C library, add the library to the repo or system and update `binding.gyp` with include_dirs and libraries entries.
-- To publish prebuilt binaries for many platforms, use tools like `prebuild` or `prebuildify` and CI to build artifacts.
-- For an alternative that avoids native compilation on user machines, consider compiling the C to WebAssembly or using `ffi-napi` to call precompiled shared libraries.
+## API
+
+### `parseMarkdown(markdown: string, route: string): ParseResult`
+
+- `markdown`: The markdown string to parse.
+- `route`: The base path for generated links.
+- Returns:  
+  - `html`: The resulting HTML string.
+  - `links_set`: A Set of all unique wikilinks found.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obby-parser",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Parse Obsidian-style markdown files including ([[links]]) into HTML and extract links",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",