10h30/wordpress-export-to-markdown
1
0
Fork 0
mirror of https://github.com/10h30/wordpress-export-to-markdown.git synced 2026-06-05 15:09:59 +09:00
Code Issues Packages Projects Releases Wiki Activity

Finish updating README

Browse Source
This commit is contained in:
Will Boyd
2024-02-28 13:58:17 -05:00
parent c0db27a154
commit 220225fca6
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -48,6 +48,8 @@ The wizard will still ask you about any options not specified on the command lin
## Options
These are the questions asked by the wizard. Command line arguments, along with their default values, are also being provided here if you want to use them.
### Path to WordPress export file?
**Command line:** `--input=export.xml`
@@ -137,14 +139,12 @@ Whether or not to download and save images scraped from `<img>` tags in post bod
Some WordPress sites make use of a `"page"` post type and/or custom post types. Set this to `true` to include these post types in the output. Posts will be organized into post type folders.
### Use wizard?
## Customizing Frontmatter and Other Advanced Settings
**Command line:** `--wizard=true`
You can edit [settings.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/settings.js) to configure advanced settings beyond the options above. This includes things like customizing frontmatter, date formatting, throttling image downloads, and more.
Enable to have the script prompt you for each option. Disable to skip the wizard and use default values for any options not specified via the command line.
You'll need to run the script locally (not using `npx`) to edit these advanced settings.
## Advanced Settings
## Contributing
You can edit [settings.js](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/src/settings.js) to tweak advanced settings. This includes things like customizing frontmatter fields and throttling image downloads.
You'll need to run the script locally (not using `npx`) to make use of advanced settings.
Please read the [contribution guidelines](https://github.com/lonekorean/wordpress-export-to-markdown/blob/master/CONTRIBUTING.md).