https://github.com/adobe/helix-md2jcr
https://github.com/adobe/helix-md2jcr
helix library
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/adobe/helix-md2jcr
- Owner: adobe
- License: apache-2.0
- Created: 2024-10-03T14:13:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T15:14:16.000Z (about 1 year ago)
- Last Synced: 2025-04-08T16:26:12.891Z (about 1 year ago)
- Topics: helix, library
- Language: JavaScript
- Homepage:
- Size: 773 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Helix Markdown to JCR
> A library that converts markdown to JCR.
## Status
[](https://codecov.io/gh/adobe/helix-md2jcr)
[](https://github.com/adobe/helix-md2jcr/blob/main/LICENSE.txt)
[](https://github.com/adobe/helix-md2jcr/issues)
[](https://github.com/semantic-release/semantic-release)
## Development
Install all dependencies by running:
```bash
npm install
```
## Usage
### Installation
You can install the package via npm:
```bash
npm install @adobe/helix-md2jcr
```
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
```
**Convert all markdown files in a directory:**
```bash
md2jcr test/fixtures/
```
**View output in console with verbose flag `-v`:**
```bash
md2jcr test/fixtures/simple.md -v
```
**View decoded XML output with `-v` and `-d` flags:**
```bash
md2jcr test/fixtures/simple.md -v -d
```
**Use custom Universal Editor files from a directory:**
```bash
md2jcr content.md -ue path/to/ue-files-directory
```
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.
#### Command-Line Options
- `-v`, `--verbose` - Print the XML output to the console
- `-d`, `--decode` - Decode HTML entities in the XML output (use with `-v`)
- `-ue`, `--ue-files ` - Specify a directory containing Universal Editor configuration files
Example directory structure:
```
ue-files/
├── component-models.json
├── component-definition.json
└── component-filters.json
```
### 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.
The script will generate new xml files beside the md files it locates. This is helpful when making changes to the converter
and you want to see if the changes have any impact on the output. By using git diff, you will see the new changes in the xml files.
If you are satisfied with the changes, you can commit the new xml files.
## Running Tests
Simply execute the following command to run the tests:
```bash
npm test
```