diff options
author | Paul Dixon <paul.dixon@durham.ac.uk> | 2014-04-04 14:55:08 +0100 |
---|---|---|
committer | Paul Dixon <paul.dixon@durham.ac.uk> | 2014-04-04 14:55:08 +0100 |
commit | b1314273bb44648547adbd1e2b7b724903ac6020 (patch) | |
tree | affad469a82e9668ffa5819ce26af9ca6ac0efd0 | |
parent | cb9a0b82ba0478b9a5b37de6f920edff474312e1 (diff) | |
download | gitbook-b1314273bb44648547adbd1e2b7b724903ac6020.zip gitbook-b1314273bb44648547adbd1e2b7b724903ac6020.tar.gz gitbook-b1314273bb44648547adbd1e2b7b724903ac6020.tar.bz2 |
Adding config option for github host
- 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
-rwxr-xr-x | bin/gitbook.js | 2 | ||||
-rw-r--r-- | lib/generate/index.js | 15 | ||||
-rw-r--r-- | templates/includes/book/exercise.html | 4 | ||||
-rw-r--r-- | templates/includes/book/header.html | 8 | ||||
-rw-r--r-- | templates/includes/book/summary.html | 8 | ||||
-rw-r--r-- | templates/layout.html | 6 |
6 files changed, 24 insertions, 19 deletions
diff --git a/bin/gitbook.js b/bin/gitbook.js index 0017cb1..6e29986 100755 --- a/bin/gitbook.js +++ b/bin/gitbook.js @@ -28,6 +28,7 @@ prog .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'); @@ -78,6 +79,7 @@ prog .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) { diff --git a/lib/generate/index.js b/lib/generate/index.js index 315ceda..ee5ffc4 100644 --- a/lib/generate/index.js +++ b/lib/generate/index.js @@ -11,16 +11,18 @@ var generate = function(root, output, options) { var files, summary, navigation, tpl; options = _.defaults(options || {}, { - // Book title, description + // Book title, keyword, description title: null, description: "Book generated using GitBook", // Origin github repository id - github: null + github: null, + githubHost: 'https://github.com/' }); - if (!options.github || !options.title) return Q.reject(new Error("Need options.github and options.title")); - + if (!options.github || !options.title) { + return Q.reject(new Error("Need options.github and options.title")); + } // Clean output folder return fs.remove(output) @@ -39,7 +41,7 @@ var generate = function(root, output, options) { files = _files; if (!_.contains(files, "SUMMARY.md") || !_.contains(files, "README.md")) { - return Q.reject(new Error("Invalid gitbook repository: need SUMMARY.md and README.md")); + return Q.reject(new Error("Invalid gitbook repository, need SUMMARY.md and README.md")); } }) @@ -65,7 +67,8 @@ var generate = function(root, output, options) { githubAuthor: options.github.split("/")[0], githubId: options.github, - + githubHost: options.githubHost, + summary: summary, allNavigation: navigation } diff --git a/templates/includes/book/exercise.html b/templates/includes/book/exercise.html index 0b52656..1acbe79 100644 --- a/templates/includes/book/exercise.html +++ b/templates/includes/book/exercise.html @@ -20,5 +20,5 @@ <div class="btn-group btn-group-justified"> <a href="#" class="btn btn-default action-submit">Submit</a> <a href="#" class="btn btn-default action-solution">Solution</a> - <a href="https://github.com/{{ githubId }}/issues/new" target="_blank" class="btn btn-default">Have a Question?</a> -</div>
\ No newline at end of file + <a href="{{ githubHost }}{{ githubId }}/issues/new" target="_blank" class="btn btn-default">Have a Question?</a> +</div> diff --git a/templates/includes/book/header.html b/templates/includes/book/header.html index 71dbbdb..d3baf1d 100644 --- a/templates/includes/book/header.html +++ b/templates/includes/book/header.html @@ -1,6 +1,6 @@ <div class="book-header"> <!-- Actions Left --> - <a href="https://github.com/{{ githubId }}" target="_blank" class="btn pull-left"><i class="fa fa-github-alt"></i></a> + <a href="{{ githubHost }}{{ githubId }}" target="_blank" class="btn pull-left"><i class="fa fa-github-alt"></i></a> <a href="#" class="btn pull-left toggle-summary"><i class="fa fa-align-justify"></i></a> <!-- Actions Right --> @@ -8,10 +8,10 @@ <a href="#" target="_blank" class="btn pull-right" data-sharing="facebook"><i class="fa fa-facebook"></i></a> <a href="#" target="_blank" class="btn pull-right" data-sharing="twitter"><i class="fa fa-twitter"></i></a> - <a href="https://github.com/{{ githubId }}/stargazers" target="_blank" class="btn pull-right count-star"><i class="fa fa-star-o"></i> Star (<span>-</span>)</a> - <a href="https://github.com/{{ githubId }}/watchers" target="_blank" class="btn pull-right count-watch"><i class="fa fa-eye"></i> Watch (<span>-</span>)</a> + <a href="{{ githubHost }}{{ githubId }}/stargazers" target="_blank" class="btn pull-right count-star"><i class="fa fa-star-o"></i> Star (<span>-</span>)</a> + <a href="{{ githubHost }}{{ githubId }}/watchers" target="_blank" class="btn pull-right count-watch"><i class="fa fa-eye"></i> Watch (<span>-</span>)</a> <!-- Title --> <h1><a href="{{ basePath }}/README.html" >{{ title }}</a></h1> -</div>
\ No newline at end of file +</div> diff --git a/templates/includes/book/summary.html b/templates/includes/book/summary.html index c3ab46d..d74fb18 100644 --- a/templates/includes/book/summary.html +++ b/templates/includes/book/summary.html @@ -1,13 +1,13 @@ <div class="book-summary"> <ul class="summary"> <li> - <a href="https://github.com/{{ githubAuthor }}" target="blank">About the author</a> + <a href="{{ githubHost }}{{ githubAuthor }}" target="blank">About the author</a> </li> <li> - <a href="https://github.com/{{ githubId }}/issues" target="blank">Questions and Issues</a> + <a href="{{ githubHost }}{{ githubId }}/issues" target="blank">Questions and Issues</a> </li> <li> - <a href="https://github.com/{{ githubId }}/edit/master/{{ _input }}" target="blank">Edit and Contribute</a> + <a href="{{ githubHost }}{{ githubId }}/edit/master/{{ _input }}" target="blank">Edit and Contribute</a> </li> <li class="divider"></li> <li data-level="0"> @@ -40,4 +40,4 @@ </li> {% endfor %} </ul> -</div>
\ No newline at end of file +</div> diff --git a/templates/layout.html b/templates/layout.html index 8d2a02f..c0f52cb 100644 --- a/templates/layout.html +++ b/templates/layout.html @@ -24,9 +24,9 @@ <meta property="og:type" content="book"> <meta property="og:locale" content="en_US"> - <meta property="book:author" content="https://github.com/{{ githubAuthor }}"> + <meta property="book:author" content="{{ githubHost }}{{ githubAuthor }}"> <meta property="book:tag" content="GitBook"> - + <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black"> @@ -48,4 +48,4 @@ <script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script> <script src="{{ staticBase }}/app.js"></script> </body> -</html>
\ No newline at end of file +</html> |