Skip to content

Commit b8caaba

Browse files
committed
Update Readme
1 parent caca75f commit b8caaba

File tree

3 files changed

+231
-217
lines changed

3 files changed

+231
-217
lines changed

README.md

+23-5
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,32 @@ To use the confluence-markdown-exporter, follow these steps:
5959

6060
3. **Exporting**: Run the exporter with the desired Confluence page ID or space key.
6161

62+
Export a single Confluence page:
63+
64+
```sh
65+
confluence-markdown-exporter page <page-id e.g. 645208921> <output path e.g. ./output_path/>
66+
```
67+
68+
Export a Confluence page and all it's descendants:
69+
70+
```sh
71+
confluence-markdown-exporter page-with-descendants <page-id e.g. 645208921> <output path e.g. ./output_path/>
72+
```
73+
74+
Export all Confluence pages of a single Space:
75+
76+
```sh
77+
confluence-markdown-exporter space <space-key e.g. MYSPACE> <output path e.g. ./output_path/>
78+
```
79+
80+
Export all Confluence pages across all spaces:
81+
6282
```sh
63-
python confluence-markdown-exporter page <page-id e.g. 645208921> <output path e.g. ./output_path/>
64-
python confluence-markdown-exporter page-with-descendants <page-id e.g. 645208921> <output path e.g. ./output_path/>
65-
python confluence-markdown-exporter space <space-key e.g. MYSPACE> <output path e.g. ./output_path/>
66-
python confluence-markdown-exporter all-spaces <output path e.g. ./output_path/>
83+
confluence-markdown-exporter all-spaces <output path e.g. ./output_path/>
6784
```
6885

69-
Instead of `confluence-markdown-exporter` you can also use the shorthand `cf-export`.
86+
> [!TIP]
87+
> Instead of `confluence-markdown-exporter` you can also use the shorthand `cf-export`.
7088
7189
4. **Output**: The exported Markdown file(s) will be saved in the specified `output` directory e.g.:
7290
```sh

logo.png

-2.19 KB
Loading

0 commit comments

Comments
 (0)