pluginFilter to import GitHub Pages as wiki pages
TypeJAR
CategoryFilter
Developed by

Hassan Ali

Active Installs9
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Provides the following features:

  • Ability to import GitHub wiki pages to XWiki.
  • Ability to convert GitHub pages content to Default syntax.
  • Ability to use Basic Authentication for GitHub page repositories that are not public.
  • Ability to create pages hierarchically in XWiki according to the sidebar (_Sidebar.md).
  • Ability to import through file / directory.
  • Supports MediaWiki and Creole syntax files.
  • Fixes relative links (with limitations) while converting syntax from Markdown to XWiki.

Usage

GitHub Importer Application

It's recommended to use the GitHub Importer Application which provides the best user experience.

Filter Streams Converter Application

It's also possible to use the generic Filter Streams Converter Application.

Make sure you have installed it. Then go to Filter Stream Converter page and set INPUT TYPE to GitHub Importer input stream (github+wiki) then set the input parameters then set OUTPUT TYPE to XWiki instance output stream (xwiki+instance) and then click Convert button.

Step 1

Go to Filter Streams Converter page.

GithubImporterFilterStep1.png

Step 2

Click on INPUT TYPE dropdown and select GitHub Importer input stream (githubimporter+wiki).

GithubImporterFilterStep2.png

Step 3

Fill the INPUT CONFIGURATION parameters.

  • (Optional) Authentication Code: The oauth / token / username (with password) used to clone private repositories.
  • XWIKI SYNTAX CONVERSION: To convert the syntax to Default syntax (Chosen in Administration > Editing > Syntaxes).
  • CREATE HIERARCHY OF PAGES: Saves the pages hierarchically according to their level defined in Sidebar.
  • PARENT: The root of all pages to be imported. (e.g. GithubImporterTest)
  • SOURCE: The wiki repository URL in the format url:<WebURL>. If you provide main repository URL (*.git) then it will automatically modify the URL to reach the Wiki repository (*.wiki.git). (e.g. url:https://github.com/Haxsen/TestRepo.wiki.git)
  • (Optional) Username: This is actually the password of the username provided in the Authentication Code.
  • VERBOSE: Let it remain true if you want to see the log.

Step 4

Click on OUTPUT TYPE dropdown and select XWiki instance output stream (xwiki+instance). You can leave the OUTPUT CONFIGURATION as is.

GithubImporterFilterStep4.png

Step 5

Scroll down and click on Convert button.

GithubImporterFilterStep5.png

Step 6

Wait until the conversion is complete, click on Job log button to see the output of XWiki pages. Once they have been created, you can click on any of them to see the output XWiki page.

GithubImporterFilterStep6.png

Awesome! You just got your GitHub wiki pages inside XWiki!

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Release Notes

v1.6

v1.5

v1.4

v1.3

v1.2

v1.1

v1.0

Dependencies

Dependencies for this extension (org.xwiki.contrib.github-importer:github-importer-filter 1.6):

Tags:
    

Get Connected