confluence-exporter-tool/README.md

Convert full Confluence Storage Format XHTML to GitHub Markdown for Foam

# confluence-exporter-tool

Convert Confluence Storage Format XHTML to GitHub Flavored Markdown (GFM).

## Features
- Converts [Confluence Storage Format](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html) to [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for use in Foam or other Markdown-based tools.
- Handles headings, lists, formatting, code blocks, macros, attachments, and more.

## Installation

Clone this repository and install dependencies:

```bash
git clone <repo-url>
cd confluence-exporter-tool
npm install
```

## Usage

```bash
node bin/index.js --input <path-to-confluence-xml> [--output <output-md-file>]
```

Or, if installed globally:

```bash
confluence-exporter-tool --input <path-to-confluence-xml> [--output <output-md-file>]
```

- `--input` (required): Path to the Confluence XML file.
- `--output` (optional): Path to save the output Markdown file. Defaults to `./output/output.md`.

### Example

```bash
node bin/index.js --input examples/sample_full_confluence.xml --output output.md
```

## Example Input
See `examples/sample_full_confluence.xml` for a sample Confluence XML file.

## License
MIT