KevinAst

Integrating GitBook with JSDoc to Document Your Open Source Project

Introduction

Good documentation should include two distinct elements - a Guide and an API:

1. The Guide builds concepts, providing examples, etc.

GitBook is well suited to

mjangda

<?php

// Edit these to match your environment settings
define( 'BASE_PATH', '/home/username/webapps' );
// This is the path to the git executable
define( 'GIT_PATH', get_full_path( '/git/bin/git' ) );

// Edit this array so the key matches the github repo name and the value is path of the repo relative to the BASE_PATH 
$repository_paths = array(
	'test' => '/git-test'