Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

little markdown format correction #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

little markdown format correction #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,29 +35,29 @@ http://johnmacfarlane.net/pandoc/installing.html

## Run

####--filename####
#### --filename ####
The only required parameter is `filename` for the name of the xml file you exported from MediaWiki, eg:

`php convert.php --filename=mediawiki.xml`

####--output####
#### --output ####
You can also use `output` to specify an output folder since each wiki page in the XML file will generate it's own separate markdown file.

`php convert.php --filename=mediawiki.xml --output=export`


####--indexes####
#### --indexes ####
You can set `indexes` as `true` if you want pages with the same name as a directory to be renamed as index.md and placed into their directory

`php convert.php --filename=mediawiki.xml --output=export --indexes=true`

####--frontmatter####
#### --frontmatter ####
You can specify whether you want frontmatter included. This is automatically set to `true` when the output format is `markdown_github`

`php convert.php --filename=mediawiki.xml --output=export --format=markdown_phpextra --frontmatter=true`


####--format####
#### --format ####
You can specify different output formats with `format`. The default is `markdown_github`. See

`php convert.php --filename=mediawiki.xml --output=export --format=markdown_phpextra`
Expand Down