https://github.com/lqs469/confluence-export

Export document from confluence with nice style
https://github.com/lqs469/confluence-export

confluence confluence-markup export export-html

Last synced: 21 days ago
JSON representation

Export document from confluence with nice style

• Host: GitHub
• URL: https://github.com/lqs469/confluence-export
• Owner: lqs469
• Created: 2017-03-14T11:42:35.000Z (over 7 years ago)
• Default Branch: dev
• Last Pushed: 2022-06-29T16:10:25.000Z (over 2 years ago)
• Last Synced: 2024-08-05T17:28:43.066Z (4 months ago)
• Topics: confluence, confluence-markup, export, export-html
• Language: JavaScript
• Homepage:
• Size: 13.9 MB
• Stars: 21
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README-zh.md

Awesome Lists containing this project

• awesome-hacking-lists - lqs469/confluence-export - Export document from confluence with nice style (JavaScript)

README

        
# comfluence2k

一键式从confluence导出成静态web文档。

### 解决问题

- confluence文档没法变成用户手册

- confluence自带的导出文档界面丑陋，交互困难，没法给用户看

### 环境需要:

- `node ^4.5.0`

- `npm ^3.0.0` or `yarn ^0.17.0`

### 使用方法

1. `git clone` 或 download repo.

1. `npm install` 或 `yarn`

1. `npm start [confluence根文章id] [文档名]`

	会以id为根目录, 导出根目录以下的结构和文章

	例如: `npm start 741256 Doc-1.0` 会导出 id=741256 下的所有子文章

1. 导出的静态文档在`./build`中, 可以打开`index.html`查看文档.

### 注意事项

- 需求原因, 目前只支持深度为2的子目录.

- 在confluence中尽量不要使用macro, 在表格中不要使用macro(否则会无法正常显示).

- 目录的顺序按照文章创建时间正序排序, 如需要调整顺序, 可以复制旧文章内容到新建的文章, 就会出现在导出文档目录最下.

- 图片使用`.png`格式.

- 目前不支持图片和代码之外的macro格式 (例如macro目录)

### 最后

- 仍在改进, 任何问题请Issues.

### Demo

![](./demo.jpg)