mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-17 08:05:19 +00:00
Paul Dixon
b1314273bb
- this config option allows the github host url to be set to something other than github.com, mainly so that github enterprise users can change the url to their private host but will also work with bitbucket
115 lines
3.4 KiB
JavaScript
Executable File
115 lines
3.4 KiB
JavaScript
Executable File
#! /usr/bin/env node
|
|
|
|
// Requires
|
|
var _ = require('lodash');
|
|
var path = require('path');
|
|
var prog = require('commander');
|
|
|
|
var fs = require('fs');
|
|
|
|
var pkg = require('../package.json');
|
|
var generate = require("../lib/generate");
|
|
var parse = require("../lib/parse");
|
|
|
|
var utils = require('./utils');
|
|
|
|
|
|
// General options
|
|
prog
|
|
.version(pkg.version)
|
|
.option('-d, --dir <source_directory>', 'Source directory of book, containing Markdown files');
|
|
|
|
|
|
var buildFunc;
|
|
prog
|
|
.command('build [source_dir]')
|
|
.description('Build a gitbook from a directory')
|
|
.option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
|
|
.option('-t, --title <name>', 'Name of the book to generate, defaults to repo name')
|
|
.option('-i, --intro <intro>', 'Description of the book to generate')
|
|
.option('-g, --github <repo_path>', 'ID of github repo like : username/repo')
|
|
.option('-gh, --githubHost <url>', 'The url of the github host (defaults to https://github.com/')
|
|
.action(buildFunc = function(dir, options) {
|
|
dir = dir || process.cwd();
|
|
outputDir = options.output || path.join(dir, '_book');
|
|
|
|
console.log('Starting build ...');
|
|
// Get repo's URL
|
|
return utils.gitURL(dir)
|
|
.then(function(url) {
|
|
// Get ID of repo
|
|
return utils.githubID(url);
|
|
}, function(err) {
|
|
return null;
|
|
})
|
|
.then(function(repoID) {
|
|
var githubID = options.github || repoID;
|
|
|
|
if(!githubID) {
|
|
throw new Error('Needs a githubID (username/repo). Either set repo origin to a github repo or use the -g flag');
|
|
}
|
|
|
|
var parts = githubID.split('/', 2);
|
|
var user = parts[0], repo = parts[1];
|
|
|
|
var title = options.title || utils.titleCase(repo);
|
|
|
|
return generate.folder(
|
|
dir,
|
|
outputDir,
|
|
{
|
|
title: title,
|
|
description: options.intro,
|
|
github: githubID
|
|
}
|
|
);
|
|
})
|
|
.then(function(output) {
|
|
console.log("Successfuly built !");
|
|
}, function(err) {
|
|
throw err;
|
|
})
|
|
.then(_.constant(outputDir));
|
|
});
|
|
|
|
prog
|
|
.command('serve [source_dir]')
|
|
.description('Build then serve a gitbook from a directory')
|
|
.option('-p, --port <port>', 'Port for server to listen on', 4000)
|
|
.option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
|
|
.option('-t, --title <name>', 'Name of the book to generate, defaults to repo name')
|
|
.option('-g, --github <repo_path>', 'ID of github repo like : username/repo')
|
|
.option('-gh, --githubHost <url>', 'The url of the github host (defaults to https://github.com/')
|
|
.action(function(dir, options) {
|
|
buildFunc(dir, options)
|
|
.then(function(outputDir) {
|
|
console.log();
|
|
console.log('Starting server ...');
|
|
return utils.serveDir(outputDir, options.port);
|
|
})
|
|
.then(function() {
|
|
console.log('Serving book on http://localhost:'+options.port);
|
|
console.log();
|
|
console.log('Press CTRL+C to quit ...');
|
|
})
|
|
.fail(function(err) {
|
|
console.error(err);
|
|
});
|
|
});
|
|
|
|
prog
|
|
.command('lex <page_file>')
|
|
.description('Parse a page file into sections, display JSON dump')
|
|
.action(function(page_file) {
|
|
var parsed = parse.page(fs.readFileSync(page_file, 'utf-8'));
|
|
|
|
console.log(JSON.stringify(parsed, null, 4));
|
|
});
|
|
|
|
|
|
|
|
// Parse and fallback to help if no args
|
|
if(_.isEmpty(prog.parse(process.argv).args) && process.argv.length === 2) {
|
|
prog.help();
|
|
}
|