update readme
This commit is contained in:
parent
d147ac338c
commit
0b6d023f0e
1 changed files with 14 additions and 3 deletions
17
README.md
17
README.md
|
@ -4,6 +4,7 @@ Customizable script for exporting notes from BookStack through API
|
||||||
#### Features:
|
#### Features:
|
||||||
- export keeping the tree structure by making folders from Shelves, Books and Chapters
|
- export keeping the tree structure by making folders from Shelves, Books and Chapters
|
||||||
- export multiple formats at once
|
- export multiple formats at once
|
||||||
|
- export at multiple levels at once (export Books or/and Chapters or/and Pages as files)
|
||||||
- customizable path for placing exported notes
|
- customizable path for placing exported notes
|
||||||
- authorization token is loaded from txt file
|
- authorization token is loaded from txt file
|
||||||
|
|
||||||
|
@ -13,9 +14,14 @@ Requirements:
|
||||||
Full example on how to use the script:
|
Full example on how to use the script:
|
||||||
1. Clone the repo
|
1. Clone the repo
|
||||||
2. next to the script place token.txt file containing token id and token secret in format: TOKEN_ID:TOKEN_SECRET
|
2. next to the script place token.txt file containing token id and token secret in format: TOKEN_ID:TOKEN_SECRET
|
||||||
3. in the same directory run the command, specifying your app domain with https prefix:
|
3. in the same directory run the command, specifying your app domain with https prefix (every parameter is optional as it have default value, this is a full possible example):
|
||||||
```bash
|
```bash
|
||||||
python exporter.py -H https://wiki.example.com -f pdf,md,plaintext,html -t ./token.txt -p ./
|
python exporter.py \
|
||||||
|
-H https://wiki.example.com \
|
||||||
|
-f pdf,md,plaintext,html \
|
||||||
|
-l pages,chapters,books
|
||||||
|
-t ./token.txt \
|
||||||
|
-p ./
|
||||||
```
|
```
|
||||||
|
|
||||||
Customization:
|
Customization:
|
||||||
|
@ -30,10 +36,15 @@ Customization:
|
||||||
-f FORMATS, --formats FORMATS
|
-f FORMATS, --formats FORMATS
|
||||||
Coma separated list of formats to use for export. Available ones: md,plaintext,pdf,html
|
Coma separated list of formats to use for export. Available ones: md,plaintext,pdf,html
|
||||||
Default: md
|
Default: md
|
||||||
|
-l LEVEL, --level LEVEL
|
||||||
|
Coma separated list of levels at which should be export performed.
|
||||||
|
Available levels: ['pages', 'chapters', 'books']
|
||||||
|
Default: pages
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### TODO:
|
### TODO:
|
||||||
- choosing verbosity level through command line parameter
|
- choosing verbosity level through command line parameter
|
||||||
- choosing on what level should the notes be exported (Books, Chapters, Pages)
|
- ~~choosing on what level should the notes be exported (Books, Chapters, Pages)~~ Done
|
||||||
- (optional) choosing if update note file only if the last edit timestamp from API is later that the local file timestamp
|
- (optional) choosing if update note file only if the last edit timestamp from API is later that the local file timestamp
|
||||||
- suggestions?
|
- suggestions?
|
||||||
|
|
Loading…
Reference in a new issue