Modify README for command line options.
This commit is contained in:
parent
a9c9e518df
commit
7bfa0d027e
|
@ -8,10 +8,16 @@ See https://www.dokuwiki.org/wiki:syntax
|
||||||
|
|
||||||
##### Running it from command line
|
##### Running it from command line
|
||||||
|
|
||||||
Just use the main python class. It uses `argparse` - only provide one argument: the directory you want to parse:
|
Just use the main python class. It uses `argparse`:
|
||||||
|
|
||||||
```python main.py --dir='some_dokuwiki_root_dir'```
|
```python main.py --dir='some_dokuwiki_root_dir'```
|
||||||
|
|
||||||
|
Command line options:
|
||||||
|
|
||||||
|
- `--dir`, the directory of your DokuWiki pages collection.
|
||||||
|
- `--frontmatter_tags=true`, whether to generate tags in the converted Hugo markdown. By default, the tool generates
|
||||||
|
tags based on the path to the document.
|
||||||
|
|
||||||
##### Including it into your python project:
|
##### Including it into your python project:
|
||||||
|
|
||||||
Main wiring in `DokuWikiToHugo` - see the tests for an elaborate example.
|
Main wiring in `DokuWikiToHugo` - see the tests for an elaborate example.
|
||||||
|
|
Loading…
Reference in New Issue