From d914eae40a9730d76295750ac47ebed9fe4f7146 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Fri, 8 Aug 2014 18:35:43 -0700 Subject: [PATCH 01/47] Remove html5 cache manifest --- bin/gitbook.js | 1 - lib/generate/manifest.js | 72 -------------------------------------- lib/generate/site/index.js | 35 ++---------------- theme/templates/site.html | 2 -- 4 files changed, 2 insertions(+), 108 deletions(-) delete mode 100644 lib/generate/manifest.js diff --git a/bin/gitbook.js b/bin/gitbook.js index 18c5c7534..7a49cde4c 100755 --- a/bin/gitbook.js +++ b/bin/gitbook.js @@ -46,7 +46,6 @@ build.command(prog.command('serve [source_dir]')) server.stop() .then(function() { return build.folder(dir, _.extend(options || {}, { - cache: false, defaultsPlugins: ["livereload"] })); }) diff --git a/lib/generate/manifest.js b/lib/generate/manifest.js deleted file mode 100644 index 8bb826a95..000000000 --- a/lib/generate/manifest.js +++ /dev/null @@ -1,72 +0,0 @@ -var _ = require('lodash'); -var path = require('path'); -var Q = require('q'); - -var fs = require("./fs"); - -var extsToIgnore = [".gz"] - -var Manifest = function() { - this.revision = 0; - this.clear(Date.now()); -}; - -// Regenerate manifest -Manifest.prototype.clear = function(revision) { - if (revision) this.revision = revision; - this.sections = { - 'CACHE': {}, - 'NETWORK': {}, - 'FALLBACK': {} - }; - return Q(this); -}; - -// Add a resource -Manifest.prototype.add = function(category, resource, value) { - if (_.isArray(resource)) { - _.each(resource, function(subres) { - this.add(category, subres, value); - }, this); - return; - } - this.sections[category][resource] = value; -}; - -// Add a directory in cache -Manifest.prototype.addFolder = function(folder, root, except) { - var that = this; - root = root || "/"; - - return fs.list(folder) - .then(function(files) { - _.each( - // Ignore diretcories - _.filter(files, function(file) { - return file.substr(-1) != "/" && !_.contains(except, path.join(root, file)) && !_.contains(extsToIgnore, path.extname(file)); - }), - function(file) { - that.add("CACHE", path.join(root, file)); - } - ); - }) -}; - -// Get manifest content -Manifest.prototype.dump = function() { - var lines = [ - "CACHE MANIFEST", - "# Revision "+this.revision - ]; - - _.each(this.sections, function(content, section) { - if (_.size(content) == 0) return; - lines.push(""); - lines.push(section+":"); - lines = lines.concat(_.keys(content)); - }, this); - - return Q(lines.join("\n")); -}; - -module.exports = Manifest; diff --git a/lib/generate/site/index.js b/lib/generate/site/index.js index 73765ae0f..6f299914a 100644 --- a/lib/generate/site/index.js +++ b/lib/generate/site/index.js @@ -9,7 +9,6 @@ var parse = require("../../parse"); var BaseGenerator = require("../generator"); var links = require("../../utils/links"); var indexer = require('./search_indexer'); -var Manifest = require('../manifest'); @@ -21,10 +20,6 @@ var Generator = function() { this.revision = Date.now(); this.indexer = indexer(); - this.manifest = new Manifest(Date.now()); - this.manifest.add("NETWORK", [ - '*' - ]); }; util.inherits(Generator, BaseGenerator); @@ -144,8 +139,6 @@ Generator.prototype.convertFile = function(content, _input) { return _callHook("page"); }) .then(function() { - that.manifest.add("CACHE", _output); - return that._writeTemplate(that.template, { progress: page.progress, @@ -189,22 +182,12 @@ Generator.prototype.copyAssets = function() { path.join(that.options.output, "gitbook") ) - // Add to cache manifest - .then(function() { - return that.manifest.addFolder(path.join(that.options.output, "gitbook"), "gitbook"); - }) - // Copy plugins assets .then(function() { return Q.all( _.map(that.plugins.list, function(plugin) { var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name); - return plugin.copyAssets(pluginAssets) - .then(function(copiedStuff) { - // Nothing was copied - if(!copiedStuff) { return; } - return that.manifest.addFolder(pluginAssets, "gitbook/plugins/"+plugin.name); - }); + return plugin.copyAssets(pluginAssets); }) ); }); @@ -219,24 +202,10 @@ Generator.prototype.writeSearchIndex = function() { }; -// Add cache manifest -Generator.prototype.writeCacheManifest = function() { - return fs.writeFile( - path.join(this.options.output, 'manifest.appcache'), - this.manifest.dump() - ); -}; - Generator.prototype.finish = function() { - var deferred = this.copyAssets() + return this.copyAssets() .then(this.copyCover) .then(this.writeSearchIndex); - - if (this.options.cache !== false) { - deferred = deferred.then(this.writeCacheManifest); - } - - return deferred; }; module.exports = Generator; diff --git a/theme/templates/site.html b/theme/templates/site.html index 6fcbebde1..ac1054f99 100644 --- a/theme/templates/site.html +++ b/theme/templates/site.html @@ -1,7 +1,5 @@ {% extends "layout.html" %} -{% block htmlTag %}{% if options.cache !== false %}manifest="{{ basePath }}/manifest.appcache"{% endif %}{% endblock %} - {% block head %} {% parent %} {% if githubAuthor %} From 78c68c7b9efd98139182c88580186d2456b1bec7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Fri, 8 Aug 2014 18:50:07 -0700 Subject: [PATCH 02/47] Remove config for github urls --- lib/generate/config.js | 91 +++++++++++++++++++++ lib/generate/index.js | 69 +--------------- lib/parse/git.js | 56 ------------- lib/parse/index.js | 3 +- theme/templates/includes/book/exercise.html | 4 +- theme/templates/includes/book/header.html | 4 +- theme/templates/includes/book/quiz.html | 4 +- theme/templates/includes/book/summary.html | 28 +++---- 8 files changed, 115 insertions(+), 144 deletions(-) create mode 100644 lib/generate/config.js delete mode 100644 lib/parse/git.js diff --git a/lib/generate/config.js b/lib/generate/config.js new file mode 100644 index 000000000..798bedc4b --- /dev/null +++ b/lib/generate/config.js @@ -0,0 +1,91 @@ +var path = require('path'); + +// Default configuration for gitbook +module.exports = { + // Folders to use for output + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json + "output": null, + + // Generator to use for building + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json + "generator": "site", + + // Book title and description (defaults are extracted from the README) + "title": null, + "description": null, + + // For ebook format, the extension to use for generation (default is detected from output extension) + // "epub", "pdf", "mobi" + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json + "extension": null, + + // Plugins list, can contain "-name" for removing default plugins + "plugins": [], + + // Global configuration for plugins + "pluginsConfig": { + "fontSettings": { + "theme": null, //"sepia", "night" or "white", + "family": "serif",// "serif" or "sans", + "size": 2 // 1 - 4 + } + }, + + // Set another theme with your own layout + // It's recommended to use plugins or add more options for default theme, though + // See https://github.com/GitbookIO/gitbook/issues/209 + "theme": path.resolve(__dirname, '../../theme'), + + // Links in template (null: default, false: remove, string: new value) + "links": { + // Link to home in the top-left corner + "home": null, + + // Links in top of sidebar + "about": null, + "issues": null, + "contribute": null, + + // Custom links at top of sidebar + "custom": { + //"Custom link name": "https://customlink.com" + }, + + // Sharing links + "sharing": { + "google": null, + "facebook": null, + "twitter": null + } + }, + + + // Options for PDF generation + "pdf": { + // Add toc at the end of the file + "toc": true, + + // Add page numbers to the bottom of every page + "pageNumbers": false, + + // Font size for the fiel content + "fontSize": 12, + + // Paper size for the pdf + // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’] + "paperSize": "a4", + + // Margin (in pts) + // Note: 72 pts equals 1 inch + "margin": { + "right": 62, + "left": 62, + "top": 36, + "bottom": 36 + } + } +}; + diff --git a/lib/generate/index.js b/lib/generate/index.js index 53de646d5..362d61373 100644 --- a/lib/generate/index.js +++ b/lib/generate/index.js @@ -7,6 +7,7 @@ var swig = require('./template'); var fs = require("./fs"); var parse = require("../parse"); var Plugin = require("./plugin"); +var defaultConfig = require("./config"); var generators = { "site": require("./site"), @@ -25,7 +26,7 @@ var containsFiles = function(dir, files) { .then(_.all); }; -// TEst if generator exists +// Test if generator exists var checkGenerator = function(options) { if (!generators[options.generator]) { return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")+")")); @@ -48,40 +49,7 @@ var loadGenerator = function(options) { var generate = function(options) { // Set defaults to options - options = _.defaults(options || {}, { - // Folders to use - "input": null, - "output": null, - - // Config file (relative to input) - "configFile": "book", - - // Output generator - "generator": "site", - - // Book title, keyword, description - "title": null, - "description": null, - - // Origin github repository id - "github": null, - "githubHost": 'https://github.com/', - - // Theming - "theme": path.resolve(__dirname, '../../theme'), - - // Plugins - "plugins": [], - "pluginsConfig": {}, - "defaultsPlugins": [], // Default plugins that can't be set in book.json - - // Links - "links": { - "about": null, - "issues": null, - "contribue": null, - } - }); + options = _.merge(options || {}, defaultConfig, _.defaults); // Validate options if (!options.input) { @@ -217,37 +185,6 @@ var generateBook = function(options) { return fs.remove(options.output); }) - // Get repo's URL - .then(function() { - // Git deactivated - if(options.github === false) { - options.github = null; - return null; - } else if(options.github) { - // Git already specified in options - options.github = ( - // Support URLs in "github" entry of book.json - parse.git.githubID(options.github) || - - // Fallback - options.github - ); - return; - } - - // Try auto detecting - return parse.git.url(options.input) - .then(function(_url) { - // Get ID of repo - return parse.git.githubID(_url); - }, function(err) { - return null; - }) - .then(function(repoId) { - options.github = repoId; - }); - }) - .then(function() { return fs.mkdirp(options.output); }) diff --git a/lib/parse/git.js b/lib/parse/git.js deleted file mode 100644 index 18a7cd398..000000000 --- a/lib/parse/git.js +++ /dev/null @@ -1,56 +0,0 @@ -var Q = require('q'); -var _ = require('lodash'); -var cp = require('child_process'); -var url = require('url'); - -// Get the remote of a given repo -function gitURL(path) { - var d = Q.defer(); - - cp.exec("git config --get remote.origin.url", { - cwd: path, - env: process.env, - }, function(err, stdout, stderr) { - if(err) { - return d.reject(err); - } - - return d.resolve(stdout); - }); - - return d.promise - .then(function(output) { - return output.replace(/(\r\n|\n|\r)/gm, ""); - }); -} - -// Poorman's parsing -// Parse a git URL to a github ID : username/reponame -function githubID(_url) { - // Remove .git if it's in _url - var sliceEnd = _url.slice(-4) === '.git' ? -4 : undefined; - - // Detect HTTPS repos - var parsed = url.parse(_url); - if(parsed.protocol === 'https:' && parsed.host === 'github.com') { - return parsed.path.slice(1, sliceEnd); - } - - // Detect SSH repos - if(_url.indexOf('git@') === 0) { - return _url.split(':', 2)[1].slice(0, sliceEnd); - } - - // None found - return null; -} - -function titleCase(str) { - return str.replace(/\w\S*/g, function(txt){return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();}); -} - -module.exports = { - url: gitURL, - githubID: githubID, - titleCase: titleCase -}; diff --git a/lib/parse/index.js b/lib/parse/index.js index bb7779f25..0ebb03a7a 100644 --- a/lib/parse/index.js +++ b/lib/parse/index.js @@ -5,6 +5,5 @@ module.exports = { lex: require('./lex'), progress: require('./progress'), navigation: require('./navigation'), - readme: require('./readme'), - git: require('./git') + readme: require('./readme') }; diff --git a/theme/templates/includes/book/exercise.html b/theme/templates/includes/book/exercise.html index faefbb7fa..cb1c4edc7 100644 --- a/theme/templates/includes/book/exercise.html +++ b/theme/templates/includes/book/exercise.html @@ -23,7 +23,7 @@
Submit Solution - {% if githubId %} - Have a Question? + {% if options.links.issues %} + Have a Question? {% endif %}
diff --git a/theme/templates/includes/book/header.html b/theme/templates/includes/book/header.html index 9b36af8b2..43898f9ac 100644 --- a/theme/templates/includes/book/header.html +++ b/theme/templates/includes/book/header.html @@ -1,8 +1,8 @@
- {% if options.links.home !== false and (options.links.home != null or githubId) %} - + {% if options.links.home %} + {% endif %} diff --git a/theme/templates/includes/book/quiz.html b/theme/templates/includes/book/quiz.html index c315a1608..3c10ffc6d 100644 --- a/theme/templates/includes/book/quiz.html +++ b/theme/templates/includes/book/quiz.html @@ -37,7 +37,7 @@
Submit Solution - {% if githubId %} - Have a Question? + {% if options.links.issues %} + Have a Question? {% endif %}
diff --git a/theme/templates/includes/book/summary.html b/theme/templates/includes/book/summary.html index 3eda4cb4c..b110c0035 100644 --- a/theme/templates/includes/book/summary.html +++ b/theme/templates/includes/book/summary.html @@ -38,35 +38,35 @@