Home

Welcome to the wiki-to-doc wiki!

Goal

Provide an easy way to create an offline, distributable version of a Github wiki.

Background

Many projects provide their documentation as a Github wiki. A Github wiki is a great, quick, accessible way to document your project.

It has the following downsides:

• The wiki may no longer be available on Github by reasons out of your control.
• You may not be able access the documentation because you do not have an internet connection.

Alternative approaches

Only use this project if the following is true:

• you need offline access to the documentation in question
• a simple git clone of the github wiki is not sufficient for your purposes

Usage

Please note that wiki-to-doc uses ~/wiki-to-doc/ as a working directory for both cloning wikis as well as collecting output.

Prerequisites

• Git installed and available on the path
• MkDocs installed and available on the path
• MkDocs version 0.12+ (the version auto-detects .md file and no longer requires the pages: ... node in mkdocs.yml).

Commands

To do For now: see the tests.

References

• embeddedlog
• build_docs.py, by @carlosperate