GitHub Importer

• Vincent Massol

2 man month

The idea is to develop an importer to import GitHub pages written in GitHub-flavored Markdown into XWiki pages written in XWiki Syntax 2.1.

To do that you would use the following existing modules in XWiki:

• Filter Application. This is a generic framework and UI to convert from one format to another.
  • Filter Module
  • XWiki instance output filter
• You can use examples of existing importers:
  • Confluence Importer
  • MediaWiki Importer
  • DokuWiki Importer
• Markdown Syntax
• Git API

Here's an idea of a possible implementation workflow:

• Since there's no GitHub REST API to access GitHub wiki pages, use the XWiki Git API to checkout/clone the underlying Git repo containing the GitHub wiki pages.
• Write an input Filter that takes as input a Git repo containing GitHub wiki pages. Use the existing XWiki Instance output filter to convert that into wiki pages.
• Use the Markdown Syntax to parse the GitHub pages and use XWiki Rendering APIs to convert that to XWiki Syntax 2.1
• See this snippet to import from GitHub

Knowledge required:

• Java

2019

Proposed