GitHub Importer

Last modified by Finn on 2026/09/10 07:38

Description

This application provides the ability to import and convert pages from GitHub to XWiki with various options. The following form provides the options to import the pages. More details on this extension and its usage are available on the Extension Page on XWiki Extensions Wiki.

Importer Options

Source Type (Required) This can be URL or a local File/Directory path. (Note: Internet access is required for URL source).
URL (Required) URL to a git repository. (e.g. https://github.com/mixxxdj/mixxx.wiki.git).
Path (Required) Path to the zip file / directory. Zip files must have a "zip" extension (file name ending in .zip). (e.g. /home/myuser/path/to/directory or /home/myuser/path/to/file.zip or E:\path\to\directory-or-file.zip).
Parent Page (Required) All of the imported pages will be created under this parent page.
Authenticator (Required for private repository) This can be a Personal Access Token, Client Secret (OAuth), or Username to be used for authentication. Personal Access Token is recommended, see Creating a personal access token page on GitHub Docs.
Password (Required with username only) The password of the user.
Convert to Default Syntax Imported pages will be converted to the default page syntax (see the Syntaxes section in the Administration).
Create hierarchy of pages Organize the imported pages hierarchically, following the heading levels defined in the GitHub Pages Sidebar (if it exists).