Skip to content
Convert MediaWiki pages to GitHub flavored Markdown
PHP
Branch: master
Clone or download
Latest commit 385ecda Nov 22, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit Oct 10, 2014
README.md Update README.md Nov 22, 2017
composer.json Initial commit Oct 10, 2014
convert.php normalize path before writing Mar 5, 2015

README.md

MediaWiki to Markdown

Convert MediaWiki pages to GitHub flavored Markdown (or other formats supported by Pandoc). The conversion uses an XML export from MediaWiki and converts each wiki page to an individual markdown file. Directory structures will be preserved. The generated export can also include frontmatter for Github pages.

You may also be interested in a forked version of this codebase available at https://github.com/outofcontrol/mediawiki-to-gfm

Requirements

  • PHP
  • Pandoc

Export MediaWiki Pages

You'll export all your pages as a single XML file following these steps: http://en.wikipedia.org/wiki/Help:Export

Installation

Install Pandoc

http://johnmacfarlane.net/pandoc/installing.html

Get Composer

curl -sS https://getcomposer.org/installer | php

Install Composer Packages

php composer.phar install

Run

####--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#### 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#### 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#### 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#### 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

Supported pandoc formats are:

  • asciidoc
  • beamer
  • context
  • docbook
  • docx
  • dokuwiki
  • dzslides
  • epub
  • epub3
  • fb2
  • haddock
  • html
  • html5
  • icml
  • json
  • latex
  • man
  • markdown
  • markdown_github
  • markdown_mmd
  • markdown_phpextra
  • markdown_strict
  • mediawiki
  • native
  • odt
  • opendocument
  • opml
  • org
  • plain
  • revealjs
  • rst
  • rtf
  • s5
  • slideous
  • slidy
  • texinfo
  • textile
You can’t perform that action at this time.