From c54a2ac1cdea7886baa45ace62f28f3d4efdb1c7 Mon Sep 17 00:00:00 2001 From: Alexandre Pinel Date: Fri, 19 Jul 2024 12:29:37 +0300 Subject: [PATCH] chore: update documentation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 829f8a1..2524ce5 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,19 @@ pip3 install -r requirements.txt python3 wiki-to-md.py ``` +Specifying if you want to download the images is optional. It is set to `yes` +by default, you can set it to `no`. + +```bash +python3 wiki-to-md.py --image-dl=no +``` + +For help: + +```bash +python3 wiki-to-md.py --help +``` + ## Output The output is a Markdown file with the same name as the topic name under the newly created directory `md_output` if using `wiki-to-md.py`. If you want to download images too, use the `wiki-to-md-images.py` file and the images will be placed inside `md_output/images/`.