onjen/confluence-space-exporter
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Fill Readme with info

Browse Source
This commit is contained in:
Johannes Rothe 2022-09-15 08:23:18 +02:00 committed by Johannes Rothe
parent 44bec53b5f
commit 39d96b35bf
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,2 +1,22 @@
# confluence-space-exporter
A little program to download Confluence spaces for offline usage or sharing with others.
An index.html is exported which reflects the pagetree of the space. Optionally attachments
are downloaded as well. Some cleanup is done to the Confluence specific HTML to be able
to render it with normal CSS.
## Usage
```
confluence-space-exporter --baseurl BASEURL --spacekey SPACEKEY --user USER --token TOKEN [--attachments]
Options:
--baseurl BASEURL Base URL of the Confluence instance (required), i.e. https://company.atlassian.net
--spacekey SPACEKEY Spacekey to export (required)
--user USER User used for authentication (required)
--token TOKEN Token used for authentication (required)
--attachments, -a Download attachments
--help, -h display this help and exit
```
After a successful export you find a folder named like the space. Open the `index.html`
in that folder with your browser to get started.