confluence-md 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -0
- package/install.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# confluence-md
|
|
2
|
+
|
|
3
|
+
CLI tool to export Confluence pages to Markdown files — **no Python required**.
|
|
4
|
+
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://www.npmjs.com/package/confluence-md)
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
# Install globally
|
|
12
|
+
npm install -g confluence-md
|
|
13
|
+
|
|
14
|
+
# Or run directly with npx
|
|
15
|
+
npx confluence-md --help
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
confluence-md --page-id <PAGE_ID> --output-path <OUTPUT_DIR> [OPTIONS]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Required Options
|
|
25
|
+
|
|
26
|
+
| Option | Description |
|
|
27
|
+
|--------|-------------|
|
|
28
|
+
| `--page-id` | Confluence page ID to export |
|
|
29
|
+
| `--output-path` | Output directory for Markdown files |
|
|
30
|
+
|
|
31
|
+
### Authentication
|
|
32
|
+
|
|
33
|
+
Set these environment variables (or pass as CLI options):
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
export CONFLUENCE_URL="https://your-domain.atlassian.net"
|
|
37
|
+
export CONFLUENCE_USER="your-email@example.com" # For Cloud
|
|
38
|
+
export CONFLUENCE_TOKEN="your-api-token"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Or use a `.env` file in your working directory.
|
|
42
|
+
|
|
43
|
+
### All Options
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
--url Confluence base URL
|
|
47
|
+
--user Username/email (Cloud) or omit for Server PAT
|
|
48
|
+
--token API token (Cloud) or Personal Access Token (Server)
|
|
49
|
+
--delay-ms Delay between API calls in ms (default: 100)
|
|
50
|
+
--timeout HTTP timeout in seconds (default: 30)
|
|
51
|
+
--skip-existing Skip files that already exist (resume capability)
|
|
52
|
+
--max-depth Maximum recursion depth (default: 50)
|
|
53
|
+
--verbose Enable verbose logging
|
|
54
|
+
--no-update-check Disable update check
|
|
55
|
+
--version Show version and exit
|
|
56
|
+
--help Show help and exit
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Export a page and all its children
|
|
63
|
+
confluence-md --page-id 123456789 --output-path ./docs
|
|
64
|
+
|
|
65
|
+
# Resume an interrupted export
|
|
66
|
+
confluence-md --page-id 123456789 --output-path ./docs --skip-existing
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Output Format
|
|
70
|
+
|
|
71
|
+
Each page is exported as a Markdown file with YAML frontmatter:
|
|
72
|
+
|
|
73
|
+
```markdown
|
|
74
|
+
---
|
|
75
|
+
title: "Page Title"
|
|
76
|
+
confluence_id: "123456789"
|
|
77
|
+
space_key: "SPACE"
|
|
78
|
+
last_modified: "2024-01-15T10:30:00Z"
|
|
79
|
+
source_url: "https://your-domain.atlassian.net/wiki/spaces/SPACE/pages/123456789"
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
# Page Title
|
|
83
|
+
|
|
84
|
+
Page content in Markdown...
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Supported Platforms
|
|
88
|
+
|
|
89
|
+
- Windows (x64)
|
|
90
|
+
- macOS (arm64, x64 via Rosetta 2)
|
|
91
|
+
- Linux (x64)
|
|
92
|
+
|
|
93
|
+
## Links
|
|
94
|
+
|
|
95
|
+
- [GitHub Repository](https://github.com/bzoboki/Confluence.md)
|
|
96
|
+
- [Report Issues](https://github.com/bzoboki/Confluence.md/issues)
|
|
97
|
+
- [Python Installation](https://github.com/bzoboki/Confluence.md#python-installation) (alternative)
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
MIT
|
package/install.js
CHANGED
|
@@ -26,7 +26,7 @@ const GITHUB_RELEASE_URL = `https://github.com/bzoboki/Confluence.md/releases/do
|
|
|
26
26
|
// Binary naming convention
|
|
27
27
|
const PLATFORM_MAP = {
|
|
28
28
|
darwin: {
|
|
29
|
-
x64: "confluence-md-macos-arm64",
|
|
29
|
+
x64: "confluence-md-macos-arm64", // x64 uses arm64 binary (Rosetta 2)
|
|
30
30
|
arm64: "confluence-md-macos-arm64",
|
|
31
31
|
},
|
|
32
32
|
linux: { x64: "confluence-md-linux-x64" },
|