@adobe/helix-md2jcr 1.1.38 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.2.0](https://github.com/adobe/helix-md2jcr/compare/v1.1.38...v1.2.0) (2025-10-06)
+
+
+### Features
+
+* add global CLI command for md2jcr ([4705024](https://github.com/adobe/helix-md2jcr/commit/47050246625b58ea93d23ac8c7fc303edc81998f))
+
 ## [1.1.38](https://github.com/adobe/helix-md2jcr/compare/v1.1.37...v1.1.38) (2025-10-06)
 
 

package/README.md

@@ -16,31 +16,69 @@ npm install
 ```
 
 ## Usage
+
+### Installation
+
 You can install the package via npm:
 
 ```bash
 npm install @adobe/helix-md2jcr
 ```
 
-## Converting Markdown to JCR Nodes
-Running the following command will generate an XML file with the JCR structure alongside of the input file.
+Or use it directly with `npx` without installing:
+
+```bash
+npx @adobe/helix-md2jcr path/to/content.md
+```
+
+### Converting Markdown to JCR Nodes
+
+The package includes a CLI tool `md2jcr` that converts markdown files to JCR XML format.
+
+**Basic usage:**
+```bash
+npx @adobe/helix-md2jcr path/to/content.md
+```
+
+**Convert a single file:**
+```bash
+md2jcr test/fixtures/simple.md
+```
 
-For example generating xml for the simple.md file, run:
+**Convert all markdown files in a directory:**
 ```bash
-node ./src/cli/convert2jcr.js test/fixtures/simple.md 
+md2jcr test/fixtures/
 ```
-If you wish to see the output in the console, you can run the following command with the verbose flag -v
+
+**View output in console with verbose flag `-v`:**
 ```bash
-node ./src/cli/convert2jcr.js test/fixtures/simple.md -v
+md2jcr test/fixtures/simple.md -v
 ```
 
-If you wish to see the decoded output in the console you can run the following command with the verbose and decode flags -v and -d:
+**View decoded XML output with `-v` and `-d` flags:**
 ```bash
-node ./src/cli/convert2jcr.js test/fixtures/simple.md -v -d
+md2jcr test/fixtures/simple.md -v -d
 ```
 
-The converter will produce a `.xml` which is the generated document converted
-from markdown. This can be used to check for potential content changes due to conversion.
+The converter will generate a `.xml` file alongside the markdown file containing the JCR structure. This can be used to check for potential content changes due to conversion.
+
+### Programmatic Usage
+
+You can also use the library programmatically in your Node.js code:
+
+```javascript
+import { md2jcr } from '@adobe/helix-md2jcr';
+
+const markdown = '# Hello World\n\nThis is a test.';
+const options = {
+  models: [...],
+  definition: {...},
+  filters: [...]
+};
+
+const xml = await md2jcr(markdown, options);
+console.log(xml);
+```
 
 ## Baseline XML Files
 Running the ./baseline-tests.sh script will detect any md file under test/fixtures and execute the convert2jcr node script.  

package/baseline-tests.sh

@@ -36,7 +36,7 @@ done
 MD_DIR="test/fixtures"
 
 # Node script to execute
-NODE_SCRIPT="src/cli/convert2jcr.js"
+NODE_SCRIPT="bin/md2jcr.js"
 
 # Check if the directory exists
 if [ ! -d "$MD_DIR" ]; then

package/{src/cli/convert2jcr.js → bin/md2jcr.js}

@@ -1,5 +1,7 @@
+#!/usr/bin/env node
+
 /*
- * Copyright 2021 Adobe. All rights reserved.
+ * Copyright 2024 Adobe. All rights reserved.
  * This file is licensed to you under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License. You may obtain a copy
  * of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -16,7 +18,7 @@ import {
 } from 'fs/promises';
 import path from 'path';
 import { decode } from 'entities';
-import { md2jcr } from '../index.js';
+import { md2jcr } from '../src/index.js';
 
 /**
  * Read a JSON file. If the file does not exist, return an empty object.

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.1.38",
+  "version": "1.2.0",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",
+  "bin": {
+    "md2jcr": "./bin/md2jcr.js"
+  },
   "scripts": {
     "test": "c8 mocha 'test/*.tests.js'",
     "lint": "eslint .",