wgroeneveld
/
dokuwiki-to-hugo
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Modify README for command line options.

This commit is contained in:
Jianfei Hu 2018-08-24 14:37:18 -07:00
parent a9c9e518df
commit 7bfa0d027e
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -8,10 +8,16 @@ See https://www.dokuwiki.org/wiki:syntax
##### 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'```
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:
Main wiring in `DokuWikiToHugo` - see the tests for an elaborate example.