mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-29 13:39:11 +00:00
Compare commits
176 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 89ba17de84 | |||
| 115fba837c | |||
| 4df51546b2 | |||
| f68aaf7ff9 | |||
| e3d1746ba3 | |||
| a0d5646034 | |||
| 2f8af5f136 | |||
| 8b7abbd6f4 | |||
| f228f646eb | |||
| 45891d80c7 | |||
| ac900aa37f | |||
| 422cbed796 | |||
| 38cbbe46aa | |||
| c1b57a387b | |||
| aaa9ae8bb7 | |||
| 6340a64cff | |||
| 96bcfa4e20 | |||
| af0f56b26b | |||
| aed5befa48 | |||
| 8e37da672d | |||
| c0f68c45e2 | |||
| 47fdd73791 | |||
| 7c0b88cf2e | |||
| bf21633b6c | |||
| ad9b1fd6f7 | |||
| d245895085 | |||
| c7439d12f7 | |||
| 8d6923ce2c | |||
| b21fb24a82 | |||
| e7be132194 | |||
| 0e1717f4bb | |||
| 276dbe29c7 | |||
| 21fd5924b8 | |||
| 443def6cfd | |||
| 75464574d7 | |||
| 86f05c68c5 | |||
| 8dd407eaa8 | |||
| ea7ad10e8a | |||
| 62ec695dc8 | |||
| ca37ac73a9 | |||
| 96edd50c8f | |||
| 3993c1e35a | |||
| 5298558925 | |||
| c6ba147917 | |||
| 7efecea3d6 | |||
| a73fed3ebd | |||
| 50ef7bcd23 | |||
| 82e422cb89 | |||
| dab46c779d | |||
| 7c65adc9b2 | |||
| 9b96ef9bae | |||
| e97d1941dc | |||
| 0b0ac46e34 | |||
| 622bbcb8ea | |||
| 58a5245d21 | |||
| 612f9a6dc7 | |||
| 90d4dff263 | |||
| 0f38385c7d | |||
| 2b50616251 | |||
| 5b7f37f0d4 | |||
| 6ca8e26741 | |||
| a3ada05598 | |||
| 42eb11aaff | |||
| b581859afd | |||
| 2e22fae52a | |||
| 603ac8b91d | |||
| 5faa4841ca | |||
| 7416b826e0 | |||
| 82afc34755 | |||
| da39631a5a | |||
| fc8685a7c1 | |||
| 5e0204a980 | |||
| 6bb0f33f39 | |||
| ed4fd565b2 | |||
| 79cff28abd | |||
| 27329239f7 | |||
| 9de86fc0e4 | |||
| 7fa7826372 | |||
| 96ecfd098b | |||
| f7fe976c7e | |||
| 756629b91d | |||
| e640d124d4 | |||
| 7f41466297 | |||
| 57dfc062d2 | |||
| 799815d85a | |||
| 2946246834 | |||
| 6d276d1e79 | |||
| 6a3a369b3e | |||
| 5d8afa2135 | |||
| ab3e6aa8ce | |||
| 822092736e | |||
| 7497acd2e3 | |||
| ae137885b8 | |||
| b964cc7009 | |||
| c2ea126c5f | |||
| b668dba479 | |||
| 2cae5a0310 | |||
| b6a0f3ff67 | |||
| fa00b52fb5 | |||
| 2999d90907 | |||
| b6696bcad2 | |||
| 728c87c525 | |||
| ace394ee2d | |||
| 076ee98f64 | |||
| 2e472654ca | |||
| d46bd14678 | |||
| b3e5b3d106 | |||
| b830ef5dca | |||
| 45326c4ad2 | |||
| 603b61e8c8 | |||
| efb066c8e3 | |||
| c30db427b1 | |||
| 23056fc85d | |||
| 5f1bfc0280 | |||
| b715901f92 | |||
| 38fea06cf9 | |||
| 4481b5f556 | |||
| 0e0d051f7c | |||
| a1b649a279 | |||
| e6bc0a0fb7 | |||
| 93e4016c09 | |||
| 20c741a248 | |||
| 54f530c7c3 | |||
| 9fdc5da22d | |||
| 99ce48b146 | |||
| 6a33ad9ef7 | |||
| ca94055adf | |||
| 36a67e4c91 | |||
| 69431e1bbb | |||
| a3fc4ee2b0 | |||
| e505fd6d54 | |||
| 93a3785e4c | |||
| a02de84812 | |||
| c0521f0ec7 | |||
| 83d8c16853 | |||
| 47e9506397 | |||
| b8a3d0e254 | |||
| 001d7ec44e | |||
| 5cb0ec447a | |||
| 67e7d77302 | |||
| 8cbd8b2b48 | |||
| 7c404dbf96 | |||
| c4a67b6f2f | |||
| 3b70347625 | |||
| bb0a7935e9 | |||
| 8f4b799d3c | |||
| 931e0c66c9 | |||
| 0212084862 | |||
| 9abbabbce3 | |||
| ac610487e8 | |||
| a9a0f89892 | |||
| 305f221077 | |||
| 53514f2602 | |||
| 00327778cb | |||
| 37fadec787 | |||
| ada11d0b59 | |||
| 4c90fdb7b2 | |||
| 98c133df3c | |||
| f86c27b090 | |||
| b5b8ed72a5 | |||
| 5beff86548 | |||
| dd395edae1 | |||
| 4a380e9279 | |||
| 878c105def | |||
| 74d628676b | |||
| 6fdd98ec3a | |||
| 2ed1be3533 | |||
| 0ac04e1584 | |||
| 2a38d33d8a | |||
| fb14caf5b3 | |||
| cf51772f54 | |||
| cc8516df83 | |||
| c6a624bc6b | |||
| 8be8b825ee | |||
| 56eb4a2897 | |||
| 7a461eaa61 |
@@ -23,3 +23,8 @@ build/Release
|
|||||||
# Deployed apps should consider commenting this line out:
|
# Deployed apps should consider commenting this line out:
|
||||||
# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
|
# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
|
||||||
node_modules
|
node_modules
|
||||||
|
|
||||||
|
theme/javascript/vendors
|
||||||
|
|
||||||
|
# vim swapfile
|
||||||
|
*.swp
|
||||||
|
|||||||
@@ -15,3 +15,4 @@ Contributors
|
|||||||
------------
|
------------
|
||||||
|
|
||||||
- Nijiko Yonskai
|
- Nijiko Yonskai
|
||||||
|
- Herman Starikov
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
# Release notes
|
||||||
|
|
||||||
+18
-6
@@ -4,10 +4,18 @@ module.exports = function (grunt) {
|
|||||||
// Load NPM tasks
|
// Load NPM tasks
|
||||||
grunt.loadNpmTasks('grunt-contrib-less');
|
grunt.loadNpmTasks('grunt-contrib-less');
|
||||||
grunt.loadNpmTasks('grunt-contrib-requirejs');
|
grunt.loadNpmTasks('grunt-contrib-requirejs');
|
||||||
|
grunt.loadNpmTasks("grunt-bower-install-simple");
|
||||||
|
|
||||||
// Init GRUNT configuraton
|
// Init GRUNT configuraton
|
||||||
grunt.initConfig({
|
grunt.initConfig({
|
||||||
pkg: grunt.file.readJSON('package.json'),
|
pkg: grunt.file.readJSON('package.json'),
|
||||||
|
'bower-install-simple': {
|
||||||
|
options: {
|
||||||
|
color: true,
|
||||||
|
production: false,
|
||||||
|
directory: "theme/javascript/vendors"
|
||||||
|
}
|
||||||
|
},
|
||||||
less: {
|
less: {
|
||||||
development: {
|
development: {
|
||||||
options: {
|
options: {
|
||||||
@@ -24,18 +32,19 @@ module.exports = function (grunt) {
|
|||||||
requirejs: {
|
requirejs: {
|
||||||
compile: {
|
compile: {
|
||||||
options: {
|
options: {
|
||||||
name: "app",
|
name: "gitbook",
|
||||||
baseUrl: "theme/javascript/",
|
baseUrl: "theme/javascript/",
|
||||||
out: "theme/assets/app.js",
|
out: "theme/assets/app.js",
|
||||||
preserveLicenseComments: false,
|
preserveLicenseComments: false,
|
||||||
optimize: "uglify", //"uglify",
|
optimize: "uglify", //"uglify",
|
||||||
include: ["requireLib"],
|
include: ["requireLib"],
|
||||||
paths: {
|
paths: {
|
||||||
"jQuery": 'vendors/jquery',
|
"jQuery": 'vendors/jquery/dist/jquery',
|
||||||
"lodash": 'vendors/lodash',
|
"lodash": 'vendors/lodash/dist/lodash',
|
||||||
"requireLib": 'vendors/require',
|
"requireLib": 'vendors/requirejs/require',
|
||||||
"Mousetrap": 'vendors/mousetrap',
|
"Mousetrap": 'vendors/mousetrap/mousetrap',
|
||||||
"lunr": path.join(__dirname, "node_modules/lunr/lunr")
|
"lunr": 'vendors/lunr.js/lunr',
|
||||||
|
"URI": 'vendors/URIjs/src/URI'
|
||||||
},
|
},
|
||||||
shim: {
|
shim: {
|
||||||
'jQuery': {
|
'jQuery': {
|
||||||
@@ -56,8 +65,11 @@ module.exports = function (grunt) {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
grunt.registerTask("bower-install", [ "bower-install-simple" ]);
|
||||||
|
|
||||||
// Build
|
// Build
|
||||||
grunt.registerTask('build', [
|
grunt.registerTask('build', [
|
||||||
|
'bower-install',
|
||||||
'less',
|
'less',
|
||||||
'requirejs'
|
'requirejs'
|
||||||
]);
|
]);
|
||||||
|
|||||||
@@ -186,7 +186,7 @@ Apache License
|
|||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Copyright {yyyy} {name of copyright owner}
|
Copyright 2014 FriendCode Inc.
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
@@ -198,4 +198,4 @@ Apache License
|
|||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
See the License for the specific language governing permissions and
|
See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ GitBook
|
|||||||
|
|
||||||
[](https://travis-ci.org/GitbookIO/gitbook)
|
[](https://travis-ci.org/GitbookIO/gitbook)
|
||||||
|
|
||||||
GitBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](http://gitbookio.github.io/javascript/). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter.
|
GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -30,13 +30,66 @@ $ gitbook build ./repository --output=./outputFolder
|
|||||||
Options for commands `build` and `serve` are:
|
Options for commands `build` and `serve` are:
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --title <name> Name of the book to generate, defaults to repo name
|
|
||||||
-i, --intro <intro> Description of the book to generate
|
|
||||||
-g, --github <repo_path> ID of github repo like : username/repo
|
|
||||||
-o, --output <directory> Path to output directory, defaults to ./_book
|
-o, --output <directory> Path to output directory, defaults to ./_book
|
||||||
-f, --format <name> Change generation format, defaults to site, availables are: site, page, pdf, json
|
-f, --format <name> Change generation format, defaults to site, availables are: site, page, pdf, json
|
||||||
--githubHost <url> The url of the github host (defaults to https://github.com/)
|
--config <config file> Configuration file to use, defaults to book.json
|
||||||
--theme <path> Path to theme directory
|
```
|
||||||
|
|
||||||
|
GitBook loads the default configuration from a `book.json` file in the repository if it exists.
|
||||||
|
|
||||||
|
Here are the options that can be stored in this file:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
// Folders to use for output (caution: it overrides the value from the command line)
|
||||||
|
"output": null,
|
||||||
|
|
||||||
|
// Generator to use for building (caution: it overrides the value from the command line)
|
||||||
|
"generator": "site",
|
||||||
|
|
||||||
|
// Book title and description (defaults are extracted from the README)
|
||||||
|
"title": null,
|
||||||
|
"description": null,
|
||||||
|
|
||||||
|
// GitHub information (defaults are extracted using git)
|
||||||
|
"github": null,
|
||||||
|
"githubHost": "https://github.com/",
|
||||||
|
|
||||||
|
// Plugins list, can contain "-name" for removing default plugins
|
||||||
|
"plugins": [],
|
||||||
|
|
||||||
|
// Global configuration for plugins
|
||||||
|
"pluginsConfig": {
|
||||||
|
"fontSettings": {
|
||||||
|
"theme": "sepia", "night" or "white",
|
||||||
|
"family": "serif" or "sans",
|
||||||
|
"size": 1 to 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": "./localtheme",
|
||||||
|
|
||||||
|
// 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,
|
||||||
|
|
||||||
|
// Sharing links
|
||||||
|
"sharing": {
|
||||||
|
"google": null,
|
||||||
|
"facebook": null,
|
||||||
|
"twitter": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
You can publish your books to our index by visiting [GitBook.io](http://www.gitbook.io)
|
You can publish your books to our index by visiting [GitBook.io](http://www.gitbook.io)
|
||||||
@@ -45,19 +98,19 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb
|
|||||||
|
|
||||||
GitBook can generate your book in the following formats:
|
GitBook can generate your book in the following formats:
|
||||||
|
|
||||||
* **Static Website**: This is the default format, it generates a complete interactive static website that can be for example hosted on GitHub Pages.
|
* **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
|
||||||
* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate to this format using: ```gitbook pdf ./myrepo```, you need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
|
* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate this format using: ```gitbook pdf ./myrepo```. You need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
|
||||||
* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate to this format using: ```gitbook ebook ./myrepo```, you need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.
|
* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.
|
||||||
* **Single Page**: The book will be stored in a single printable HTML page, this format is used for conversion to PDF or eBook. Generate to this format using: ```gitbook build ./myrepo -f page```.
|
* **Single Page**: The book will be stored in a single printable HTML page. This format is used for conversion to PDF or eBook. Generate this format using: ```gitbook build ./myrepo -f page```.
|
||||||
* **JSON**: This format is used for debugging or extracting metadata from a book. Generate to this format using: ```gitbook build ./myrepo -f json```.
|
* **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
|
||||||
|
|
||||||
## Book Format
|
## Book Format
|
||||||
|
|
||||||
A book is a GitHub repository containing at least 2 files: `README.md` and `SUMMARY.md`.
|
A book is a Git repository containing at least 2 files: `README.md` and `SUMMARY.md`.
|
||||||
|
|
||||||
#### README.md
|
#### README.md
|
||||||
|
|
||||||
As usual, it should contains an introduction for your book. It will be automatically added to the final summary.
|
Typically, this should be the introduction for your book. It will be automatically added to the final summary.
|
||||||
|
|
||||||
#### SUMMARY.md
|
#### SUMMARY.md
|
||||||
|
|
||||||
@@ -77,11 +130,11 @@ This is the summary of my book.
|
|||||||
* [example 1](section2/example1.md)
|
* [example 1](section2/example1.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
Files that are not included in the `SUMMARY.md` will not be processed by `gitbook`.
|
Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
|
||||||
|
|
||||||
#### Exercises
|
#### Exercises
|
||||||
|
|
||||||
A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, which is given a code editor to write a solution which is checked against the book author's validation code.
|
A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, who is given a code editor to write a solution which is checked against the book author's validation code.
|
||||||
|
|
||||||
An exercise is defined by 4 simple parts:
|
An exercise is defined by 4 simple parts:
|
||||||
|
|
||||||
@@ -90,7 +143,7 @@ An exercise is defined by 4 simple parts:
|
|||||||
* **Solution** code, being a correct solution to the exercise
|
* **Solution** code, being a correct solution to the exercise
|
||||||
* **Validation** code that tests the correctness of the user's input
|
* **Validation** code that tests the correctness of the user's input
|
||||||
|
|
||||||
Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries etc ... that shouldn't be displayed to the user).
|
Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries, etc which shouldn't be displayed to the user).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -132,4 +185,35 @@ You can see a complete example with the [Learn Git](https://github.com/GitbookIO
|
|||||||
|
|
||||||
#### Ignoring files & folders
|
#### Ignoring files & folders
|
||||||
|
|
||||||
GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files, follows the same convention as `.gitignore`)
|
GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files follows the same convention as `.gitignore`)
|
||||||
|
|
||||||
|
#### Cover
|
||||||
|
|
||||||
|
A cover image can be set by creating a file: **/cover.jpg**.
|
||||||
|
The best resolution is **1800x2360**. The generation of the cover can be done automatically using the plugin [autocover](https://github.com/GitbookIO/plugin-autocover).
|
||||||
|
|
||||||
|
A small version of the cover can also be set by creating a file: **/cover_small.jpg**.
|
||||||
|
|
||||||
|
#### Publish your book
|
||||||
|
|
||||||
|
The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books": you can create a book on it (public, paid, or private) and update it using **git push**.
|
||||||
|
|
||||||
|
#### Plugins
|
||||||
|
|
||||||
|
Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
|
||||||
|
|
||||||
|
##### Default plugins:
|
||||||
|
|
||||||
|
* [mathjax](https://github.com/GitbookIO/plugin-mathjax): displays mathematical notation in the book.
|
||||||
|
* [mixpanel](https://github.com/GitbookIO/plugin-mixpanel): Mixpanel tracking for your book
|
||||||
|
|
||||||
|
##### Other plugins:
|
||||||
|
|
||||||
|
* [Google Analytics](https://github.com/GitbookIO/plugin-ga): Google Analytics tracking for your book
|
||||||
|
* [Disqus](https://github.com/GitbookIO/plugin-disqus): Disqus comments integration in your book
|
||||||
|
* [Autocover](https://github.com/GitbookIO/plugin-autocover): Generate a cover for your book
|
||||||
|
* [Transform annoted quotes to notes](https://github.com/erixtekila/gitbook-plugin-richquotes): Allow extra markdown markup to render blockquotes as nice notes
|
||||||
|
* [Send code to console](https://github.com/erixtekila/gitbook-plugin-toconsole): Evaluate javascript block in the browser inspector's console
|
||||||
|
* [Revealable sections](https://github.com/mrpotes/gitbook-plugin-reveal): Reveal sections of the page using buttons made from the first title in each section
|
||||||
|
* [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages
|
||||||
|
* [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook
|
||||||
|
|||||||
+26
-29
@@ -1,50 +1,47 @@
|
|||||||
var path = require('path');
|
var path = require('path');
|
||||||
var Q = require('q');
|
var Q = require('q');
|
||||||
var _ = require('lodash');
|
var _ = require('lodash');
|
||||||
|
var fs = require('fs');
|
||||||
|
|
||||||
var utils = require('./utils');
|
var utils = require('./utils');
|
||||||
|
|
||||||
var generate = require("../lib/generate");
|
var generate = require("../lib/generate");
|
||||||
var parse = require("../lib/parse");
|
var parse = require("../lib/parse");
|
||||||
var fs = require('../lib/generate/fs');
|
|
||||||
var generators = require("../lib/generate").generators;
|
var generators = require("../lib/generate").generators;
|
||||||
|
|
||||||
|
var buildCommand = function(command) {
|
||||||
|
return command
|
||||||
|
.option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
|
||||||
|
.option('-f, --format <name>', 'Change generation format, defaults to site, availables are: '+_.keys(generators).join(", "))
|
||||||
|
.option('--config <config file>', 'Configuration file to use, defualt to book.json')
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
var makeBuildFunc = function(converter) {
|
var makeBuildFunc = function(converter) {
|
||||||
return function(dir, options) {
|
return function(dir, options) {
|
||||||
dir = dir || process.cwd();
|
dir = dir || process.cwd();
|
||||||
outputDir = options.output
|
outputDir = options.output;
|
||||||
|
|
||||||
console.log('Starting build ...');
|
console.log('Starting build ...');
|
||||||
// Get repo's URL
|
return converter(
|
||||||
return utils.gitURL(dir)
|
_.extend({}, options || {}, {
|
||||||
.then(function(url) {
|
input: dir,
|
||||||
// Get ID of repo
|
output: outputDir,
|
||||||
return utils.githubID(url);
|
generator: options.format,
|
||||||
}, function(err) {
|
configFile: options.config
|
||||||
return null;
|
})
|
||||||
})
|
)
|
||||||
.then(function(repoID) {
|
|
||||||
return converter(
|
|
||||||
_.extend(options || {}, {
|
|
||||||
input: dir,
|
|
||||||
output: outputDir,
|
|
||||||
title: options.title,
|
|
||||||
description: options.intro,
|
|
||||||
github: options.github || repoID,
|
|
||||||
githubHost: options.githubHost,
|
|
||||||
generator: options.format,
|
|
||||||
theme: options.theme
|
|
||||||
})
|
|
||||||
);
|
|
||||||
})
|
|
||||||
.then(function(output) {
|
.then(function(output) {
|
||||||
console.log("Successfuly built !");
|
console.log("Successfuly built !");
|
||||||
return output;
|
return output;
|
||||||
}, utils.logError);
|
}, utils.logError)
|
||||||
};
|
.fail(function() {
|
||||||
}
|
process.exit(-1);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
folder: makeBuildFunc(generate.folder),
|
folder: makeBuildFunc(generate.folder),
|
||||||
file: makeBuildFunc(generate.file)
|
file: makeBuildFunc(generate.file),
|
||||||
|
command: buildCommand
|
||||||
};
|
};
|
||||||
|
|||||||
+57
-27
@@ -4,6 +4,7 @@ var Q = require('q');
|
|||||||
var _ = require('lodash');
|
var _ = require('lodash');
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
var prog = require('commander');
|
var prog = require('commander');
|
||||||
|
var tinylr = require('tiny-lr-fork');
|
||||||
|
|
||||||
var pkg = require('../package.json');
|
var pkg = require('../package.json');
|
||||||
var generators = require("../lib/generate").generators;
|
var generators = require("../lib/generate").generators;
|
||||||
@@ -12,45 +13,74 @@ var fs = require('../lib/generate/fs');
|
|||||||
|
|
||||||
var utils = require('./utils');
|
var utils = require('./utils');
|
||||||
var build = require('./build');
|
var build = require('./build');
|
||||||
|
var Server = require('./server');
|
||||||
|
|
||||||
// General options
|
// General options
|
||||||
prog
|
prog
|
||||||
.version(pkg.version);
|
.version(pkg.version);
|
||||||
|
|
||||||
var buildCommand = function(command) {
|
build.command(prog.command('build [source_dir]'))
|
||||||
return command
|
|
||||||
.option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
|
|
||||||
.option('-f, --format <name>', 'Change generation format, defaults to site, availables are: '+_.keys(generators).join(", "))
|
|
||||||
.option('-t, --title <name>', 'Name of the book to generate, default is extracted from readme')
|
|
||||||
.option('-i, --intro <intro>', 'Description of the book to generate, default is extracted from readme')
|
|
||||||
.option('-g, --github <repo_path>', 'ID of github repo like : username/repo')
|
|
||||||
.option('--githubHost <url>', 'The url of the github host (defaults to https://github.com/')
|
|
||||||
.option('--theme <path>', 'Path to theme directory');
|
|
||||||
};
|
|
||||||
|
|
||||||
buildCommand(prog.command('build [source_dir]'))
|
|
||||||
.description('Build a gitbook from a directory')
|
.description('Build a gitbook from a directory')
|
||||||
.action(build.folder);
|
.action(build.folder);
|
||||||
|
|
||||||
buildCommand(prog.command('serve [source_dir]'))
|
build.command(prog.command('serve [source_dir]'))
|
||||||
.description('Build then serve a gitbook from a directory')
|
.description('Build then serve a gitbook from a directory')
|
||||||
.option('-p, --port <port>', 'Port for server to listen on', 4000)
|
.option('-p, --port <port>', 'Port for server to listen on', 4000)
|
||||||
|
.option('--no-watch', 'Disable restart with file watching')
|
||||||
.action(function(dir, options) {
|
.action(function(dir, options) {
|
||||||
build.folder(dir, options || {})
|
var server = new Server();
|
||||||
.then(function(_options) {
|
|
||||||
console.log();
|
// init livereload server
|
||||||
console.log('Starting server ...');
|
var lrOptions = {port: 35729};
|
||||||
return utils.serveDir(_options.output, options.port)
|
var lrServer = tinylr(lrOptions);
|
||||||
.fail(utils.logError);
|
var lrPath = undefined;
|
||||||
})
|
lrServer.listen(lrOptions.port, function(err) {
|
||||||
.then(function() {
|
if (err) { return console.log(err); }
|
||||||
console.log('Serving book on http://localhost:'+options.port);
|
console.log('Live reload server started on port: ' + lrOptions.port);
|
||||||
console.log();
|
|
||||||
console.log('Press CTRL+C to quit ...');
|
|
||||||
});
|
});
|
||||||
|
|
||||||
|
var generate = function() {
|
||||||
|
if (server.isRunning()) console.log("Stopping server");
|
||||||
|
|
||||||
|
server.stop()
|
||||||
|
.then(function() {
|
||||||
|
return build.folder(dir, _.extend(options || {}, {
|
||||||
|
cache: false,
|
||||||
|
defaultsPlugins: ["livereload"]
|
||||||
|
}));
|
||||||
|
})
|
||||||
|
.then(function(_options) {
|
||||||
|
console.log();
|
||||||
|
console.log('Starting server ...');
|
||||||
|
return server.start(_options.output, options.port)
|
||||||
|
.then(function() {
|
||||||
|
console.log('Serving book on http://localhost:'+options.port);
|
||||||
|
|
||||||
|
if (lrPath) {
|
||||||
|
// trigger livereload
|
||||||
|
lrServer.changed({body:{files:[lrPath]}})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!options.watch) return;
|
||||||
|
return utils.watch(_options.input)
|
||||||
|
.then(function(filepath) {
|
||||||
|
// set livereload path
|
||||||
|
lrPath = filepath;
|
||||||
|
console.log("Restart after change in files");
|
||||||
|
console.log('');
|
||||||
|
return generate();
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.fail(utils.logError);
|
||||||
|
};
|
||||||
|
|
||||||
|
console.log('Press CTRL+C to quit ...');
|
||||||
|
console.log('')
|
||||||
|
generate();
|
||||||
});
|
});
|
||||||
|
|
||||||
buildCommand(prog.command('pdf [source_dir]'))
|
build.command(prog.command('pdf [source_dir]'))
|
||||||
.description('Build a gitbook as a PDF')
|
.description('Build a gitbook as a PDF')
|
||||||
.option('-pf, --paperformat <format>', 'PDF paper format (default is A4): "5in*7.5in", "10cm*20cm", "A4", "Letter"')
|
.option('-pf, --paperformat <format>', 'PDF paper format (default is A4): "5in*7.5in", "10cm*20cm", "A4", "Letter"')
|
||||||
.action(function(dir, options) {
|
.action(function(dir, options) {
|
||||||
@@ -60,9 +90,9 @@ buildCommand(prog.command('pdf [source_dir]'))
|
|||||||
}));
|
}));
|
||||||
});
|
});
|
||||||
|
|
||||||
buildCommand(prog.command('ebook [source_dir]'))
|
build.command(prog.command('ebook [source_dir]'))
|
||||||
.description('Build a gitbook as a eBook')
|
.description('Build a gitbook as a eBook')
|
||||||
.option('-c, --cover <path>', 'Cover image, default is cover.png if exists')
|
.option('-c, --cover <path>', 'Cover image, default is cover.jpg if exists')
|
||||||
.action(function(dir, options) {
|
.action(function(dir, options) {
|
||||||
var ext = options.output ? path.extname(options.output) : "epub";
|
var ext = options.output ? path.extname(options.output) : "epub";
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,96 @@
|
|||||||
|
var Q = require('q');
|
||||||
|
var _ = require('lodash');
|
||||||
|
|
||||||
|
var events = require('events');
|
||||||
|
var http = require('http');
|
||||||
|
var send = require('send');
|
||||||
|
var util = require('util');
|
||||||
|
var url = require('url');
|
||||||
|
|
||||||
|
var Server = function() {
|
||||||
|
this.running = null;
|
||||||
|
this.dir = null;
|
||||||
|
this.port = 0;
|
||||||
|
this.sockets = [];
|
||||||
|
};
|
||||||
|
util.inherits(Server, events.EventEmitter);
|
||||||
|
|
||||||
|
// Return true if the server is running
|
||||||
|
Server.prototype.isRunning = function() {
|
||||||
|
return this.running != null;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Stop the server
|
||||||
|
Server.prototype.stop = function() {
|
||||||
|
var that = this;
|
||||||
|
if (!this.isRunning()) return Q();
|
||||||
|
|
||||||
|
var d = Q.defer();
|
||||||
|
this.running.close(function(err) {
|
||||||
|
that.running = null;
|
||||||
|
that.emit("state", false);
|
||||||
|
|
||||||
|
if (err) d.reject(err);
|
||||||
|
else d.resolve();
|
||||||
|
});
|
||||||
|
|
||||||
|
for (var i = 0; i < this.sockets.length; i++) {
|
||||||
|
this.sockets[i].destroy();
|
||||||
|
}
|
||||||
|
|
||||||
|
return d.promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
Server.prototype.start = function(dir, port) {
|
||||||
|
var that = this, pre = Q();
|
||||||
|
port = port || 8004;
|
||||||
|
|
||||||
|
if (that.isRunning()) pre = this.stop();
|
||||||
|
return pre
|
||||||
|
.then(function() {
|
||||||
|
var d = Q.defer();
|
||||||
|
|
||||||
|
that.running = http.createServer(function(req, res){
|
||||||
|
// Render error
|
||||||
|
function error(err) {
|
||||||
|
res.statusCode = err.status || 500;
|
||||||
|
res.end(err.message);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Redirect to directory's index.html
|
||||||
|
function redirect() {
|
||||||
|
res.statusCode = 301;
|
||||||
|
res.setHeader('Location', req.url + '/');
|
||||||
|
res.end('Redirecting to ' + req.url + '/');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send file
|
||||||
|
send(req, url.parse(req.url).pathname)
|
||||||
|
.root(dir)
|
||||||
|
.on('error', error)
|
||||||
|
.on('directory', redirect)
|
||||||
|
.pipe(res);
|
||||||
|
});
|
||||||
|
|
||||||
|
that.running.on('connection', function (socket) {
|
||||||
|
that.sockets.push(socket);
|
||||||
|
socket.setTimeout(4000);
|
||||||
|
socket.on('close', function () {
|
||||||
|
that.sockets.splice(that.sockets.indexOf(socket), 1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
that.running.listen(port, function(err) {
|
||||||
|
if (err) return d.reject(err);
|
||||||
|
|
||||||
|
that.port = port;
|
||||||
|
that.dir = dir;
|
||||||
|
that.emit("state", true);
|
||||||
|
d.resolve();
|
||||||
|
});
|
||||||
|
|
||||||
|
return d.promise;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = Server;
|
||||||
+18
-75
@@ -4,98 +4,41 @@ var _ = require('lodash');
|
|||||||
var http = require('http');
|
var http = require('http');
|
||||||
var send = require('send');
|
var send = require('send');
|
||||||
|
|
||||||
var url = require('url');
|
var path = require('path');
|
||||||
var cp = require('child_process');
|
var Gaze = require('gaze').Gaze;
|
||||||
|
|
||||||
|
function watch(dir) {
|
||||||
// Get the remote of a given repo
|
|
||||||
function gitURL(path) {
|
|
||||||
var d = Q.defer();
|
var d = Q.defer();
|
||||||
|
dir = path.resolve(dir);
|
||||||
|
|
||||||
cp.exec("git config --get remote.origin.url", {
|
var gaze = new Gaze("**/*.md", {
|
||||||
cwd: path,
|
cwd: dir
|
||||||
env: process.env,
|
|
||||||
}, function(err, stdout, stderr) {
|
|
||||||
if(err) {
|
|
||||||
return d.reject(err);
|
|
||||||
}
|
|
||||||
|
|
||||||
return d.resolve(stdout);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return d.promise
|
gaze.once("all", function(e, filepath) {
|
||||||
.then(function(output) {
|
gaze.close();
|
||||||
return output.replace(/(\r\n|\n|\r)/gm, "");
|
|
||||||
|
d.resolve(filepath);
|
||||||
});
|
});
|
||||||
}
|
gaze.once("error", function(err) {
|
||||||
|
gaze.close();
|
||||||
|
|
||||||
// Poorman's parsing
|
d.reject(err);
|
||||||
// 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 : _url.length;
|
|
||||||
|
|
||||||
// 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();});
|
|
||||||
}
|
|
||||||
|
|
||||||
function serveDir(dir, port) {
|
|
||||||
var d = Q.defer();
|
|
||||||
|
|
||||||
var server = http.createServer(function(req, res){
|
|
||||||
// Render error
|
|
||||||
function error(err) {
|
|
||||||
res.statusCode = err.status || 500;
|
|
||||||
res.end(err.message);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Redirect to directory's index.html
|
|
||||||
function redirect() {
|
|
||||||
res.statusCode = 301;
|
|
||||||
res.setHeader('Location', req.url + '/');
|
|
||||||
res.end('Redirecting to ' + req.url + '/');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send file
|
|
||||||
send(req, url.parse(req.url).pathname)
|
|
||||||
.root(dir)
|
|
||||||
.on('error', error)
|
|
||||||
.on('directory', redirect)
|
|
||||||
.pipe(res);
|
|
||||||
}).listen(port);
|
|
||||||
|
|
||||||
d.resolve(server);
|
|
||||||
|
|
||||||
return d.promise;
|
return d.promise;
|
||||||
}
|
}
|
||||||
|
|
||||||
function logError(err) {
|
function logError(err) {
|
||||||
console.log(err.stack || err.message || err);
|
var message = err.message || err;
|
||||||
|
if (process.env.DEBUG != null) message = err.stack || message;
|
||||||
|
console.log(message);
|
||||||
return Q.reject(err);
|
return Q.reject(err);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
// Exports
|
// Exports
|
||||||
module.exports = {
|
module.exports = {
|
||||||
gitURL: gitURL,
|
watch: watch,
|
||||||
githubID: githubID,
|
|
||||||
titleCase: titleCase,
|
|
||||||
serveDir: serveDir,
|
|
||||||
logError: logError
|
logError: logError
|
||||||
};
|
};
|
||||||
|
|||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"name": "GitBook",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"dependencies": {
|
||||||
|
"jquery": "2.1.1",
|
||||||
|
"lodash": "2.4.1",
|
||||||
|
"requirejs": "2.1.11",
|
||||||
|
"URIjs": "1.13.1",
|
||||||
|
"mousetrap": "1.4.6",
|
||||||
|
"lunr.js": "0.5.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -19,10 +19,6 @@ var Generator = function() {
|
|||||||
this.options = _.defaults(this.options, {
|
this.options = _.defaults(this.options, {
|
||||||
extension: "epub"
|
extension: "epub"
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!this.options.cover && fs.existsSync(path.join(this.options.input, "cover.png"))) {
|
|
||||||
this.options.cover = path.join(this.options.input, "cover.png")
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
util.inherits(Generator, BaseGenerator);
|
util.inherits(Generator, BaseGenerator);
|
||||||
|
|
||||||
@@ -33,6 +29,10 @@ Generator.prototype.finish = function() {
|
|||||||
.then(function() {
|
.then(function() {
|
||||||
var d = Q.defer();
|
var d = Q.defer();
|
||||||
|
|
||||||
|
if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
|
||||||
|
that.options.cover = path.join(that.options.output, "cover.jpg");
|
||||||
|
}
|
||||||
|
|
||||||
var _options = {
|
var _options = {
|
||||||
"--cover": that.options.cover
|
"--cover": that.options.cover
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ var getFiles = function(path) {
|
|||||||
ig.addIgnoreRules([
|
ig.addIgnoreRules([
|
||||||
'.git/',
|
'.git/',
|
||||||
'.gitignore',
|
'.gitignore',
|
||||||
|
'.DS_Store'
|
||||||
], '__custom_stuff');
|
], '__custom_stuff');
|
||||||
|
|
||||||
// Push each file to our list
|
// Push each file to our list
|
||||||
|
|||||||
@@ -1,9 +1,31 @@
|
|||||||
|
var _ = require("lodash");
|
||||||
var path = require("path");
|
var path = require("path");
|
||||||
var Q = require("q");
|
var Q = require("q");
|
||||||
var fs = require("./fs");
|
var fs = require("./fs");
|
||||||
|
|
||||||
|
var Plugin = require("./plugin");
|
||||||
|
|
||||||
var BaseGenerator = function(options) {
|
var BaseGenerator = function(options) {
|
||||||
this.options = options;
|
this.options = options;
|
||||||
|
|
||||||
|
this.options.plugins = Plugin.normalizeNames(this.options.plugins);
|
||||||
|
this.options.plugins = _.union(this.options.plugins, this.options.defaultsPlugins);
|
||||||
|
this.plugins = [];
|
||||||
|
};
|
||||||
|
|
||||||
|
BaseGenerator.prototype.callHook = function(name, data) {
|
||||||
|
return this.plugins.hook(name, this, data);
|
||||||
|
};
|
||||||
|
|
||||||
|
BaseGenerator.prototype.loadPlugins = function() {
|
||||||
|
var that = this;
|
||||||
|
|
||||||
|
return Plugin.fromList(this.options.plugins, this.options.input)
|
||||||
|
.then(function(_plugins) {
|
||||||
|
that.plugins = _plugins;
|
||||||
|
|
||||||
|
return that.callHook("init");
|
||||||
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
BaseGenerator.prototype.convertFile = function(content, input) {
|
BaseGenerator.prototype.convertFile = function(content, input) {
|
||||||
|
|||||||
+237
-108
@@ -6,6 +6,7 @@ var tmp = require('tmp');
|
|||||||
|
|
||||||
var fs = require("./fs");
|
var fs = require("./fs");
|
||||||
var parse = require("../parse");
|
var parse = require("../parse");
|
||||||
|
var Plugin = require("./plugin");
|
||||||
|
|
||||||
var generators = {
|
var generators = {
|
||||||
"site": require("./site"),
|
"site": require("./site"),
|
||||||
@@ -17,46 +18,209 @@ var generators = {
|
|||||||
|
|
||||||
var defaultDescription = "Book generated using GitBook";
|
var defaultDescription = "Book generated using GitBook";
|
||||||
|
|
||||||
/*
|
|
||||||
* Use a specific generator to convert a gitbook to a site/pdf/ebook/
|
|
||||||
* output is always a folder
|
|
||||||
*/
|
|
||||||
var generate = function(options) {
|
|
||||||
var generator = null;
|
|
||||||
var files;
|
|
||||||
|
|
||||||
|
var containsFiles = function(dir, files) {
|
||||||
|
return Q.all(_.map(files, function(file) {
|
||||||
|
return fs.exists(path.join(dir, file));
|
||||||
|
}))
|
||||||
|
.then(_.all);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
// Create the generator and load plugins
|
||||||
|
var loadGenerator = function(options) {
|
||||||
|
var generator = new generators[options.generator](options);
|
||||||
|
|
||||||
|
return generator.loadPlugins()
|
||||||
|
.then(_.constant(generator));
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
var generate = function(options) {
|
||||||
|
// Set defaults to options
|
||||||
options = _.defaults(options || {}, {
|
options = _.defaults(options || {}, {
|
||||||
// Folders to use
|
// Folders to use
|
||||||
input: null,
|
"input": null,
|
||||||
output: null,
|
"output": null,
|
||||||
|
|
||||||
|
// Config file (relative to input)
|
||||||
|
"configFile": "book.json",
|
||||||
|
|
||||||
// Output generator
|
// Output generator
|
||||||
generator: "site",
|
"generator": "site",
|
||||||
|
|
||||||
// Book title, keyword, description
|
// Book title, keyword, description
|
||||||
title: null,
|
"title": null,
|
||||||
description: null,
|
"description": null,
|
||||||
|
|
||||||
// Origin github repository id
|
// Origin github repository id
|
||||||
github: null,
|
"github": null,
|
||||||
githubHost: 'https://github.com/',
|
"githubHost": 'https://github.com/',
|
||||||
|
|
||||||
// Theming
|
// Theming
|
||||||
theme: path.resolve(__dirname, '../../theme')
|
"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,
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Validate options
|
||||||
if (!options.input) {
|
if (!options.input) {
|
||||||
return Q.reject(new Error("Need option input (book input directory)"));
|
return Q.reject(new Error("Need option input (book input directory)"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Ensure generator exists
|
||||||
if (!generators[options.generator]) {
|
if (!generators[options.generator]) {
|
||||||
return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")));
|
return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check files to get folder type (book, multilanguage book or neither)
|
||||||
|
return Q()
|
||||||
|
|
||||||
|
// Read config file
|
||||||
|
.then(function() {
|
||||||
|
return fs.readFile(path.resolve(options.input, options.configFile))
|
||||||
|
.then(function(_config) {
|
||||||
|
// Extend current config
|
||||||
|
_config = JSON.parse(_config);
|
||||||
|
_config = _.omit(_config, 'input', 'configFile', 'defaultsPlugins');
|
||||||
|
|
||||||
|
_.extend(options, _config);
|
||||||
|
}, function() {
|
||||||
|
// No config file: not a big deal
|
||||||
|
return Q();
|
||||||
|
});
|
||||||
|
})
|
||||||
|
|
||||||
|
// Read readme
|
||||||
|
.then(function() {
|
||||||
|
return fs.readFile(path.join(options.input, "README.md"), "utf-8")
|
||||||
|
.then(function(_readme) {
|
||||||
|
_readme = parse.readme(_readme);
|
||||||
|
|
||||||
|
options.title = options.title || _readme.title;
|
||||||
|
options.description = options.description || _readme.description || defaultDescription;
|
||||||
|
});
|
||||||
|
})
|
||||||
|
|
||||||
|
// Detect multi-languages book
|
||||||
|
.then(function() {
|
||||||
|
return containsFiles(options.input, ['LANGS.md'])
|
||||||
|
})
|
||||||
|
|
||||||
|
.then(function(isMultiLang) {
|
||||||
|
// Multi language book
|
||||||
|
if(isMultiLang) {
|
||||||
|
return generateMultiLang(options);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Book
|
||||||
|
return generateBook(options);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
var generateMultiLang = function(options) {
|
||||||
|
var langsSummary;
|
||||||
options.output = options.output || path.join(options.input, "_book");
|
options.output = options.output || path.join(options.input, "_book");
|
||||||
|
|
||||||
|
// Multi-languages book
|
||||||
|
return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
|
||||||
|
|
||||||
// Clean output folder
|
// Clean output folder
|
||||||
return fs.remove(options.output)
|
.then(function(_langsSummary) {
|
||||||
|
langsSummary = _langsSummary;
|
||||||
|
return fs.remove(options.output);
|
||||||
|
})
|
||||||
|
.then(function() {
|
||||||
|
return fs.mkdirp(options.output);
|
||||||
|
})
|
||||||
|
|
||||||
|
// Generate sub-books
|
||||||
|
.then(function() {
|
||||||
|
options.langsSummary = parse.langs(langsSummary);
|
||||||
|
|
||||||
|
// Generated a book for each valid entry
|
||||||
|
return _.reduce(options.langsSummary.list, function(prev, entry) {
|
||||||
|
return prev.then(function() {
|
||||||
|
return generate(_.extend({}, options, {
|
||||||
|
input: path.join(options.input, entry.path),
|
||||||
|
output: path.join(options.output, entry.path)
|
||||||
|
}));
|
||||||
|
})
|
||||||
|
}, Q());
|
||||||
|
})
|
||||||
|
|
||||||
|
.then(function() {
|
||||||
|
return loadGenerator(options);
|
||||||
|
})
|
||||||
|
|
||||||
|
// Generate languages index
|
||||||
|
.then(function(generator) {
|
||||||
|
return generator.langsIndex(options.langsSummary);
|
||||||
|
})
|
||||||
|
|
||||||
|
// Return options to caller
|
||||||
|
.then(_.constant(options));
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Use a specific generator to convert a gitbook to a site/pdf/ebook/
|
||||||
|
* output is always a folder
|
||||||
|
*/
|
||||||
|
var generateBook = function(options) {
|
||||||
|
var files;
|
||||||
|
|
||||||
|
options.output = options.output || path.join(options.input, "_book");
|
||||||
|
|
||||||
|
// Check if it's a book
|
||||||
|
return containsFiles(options.input, ['SUMMARY.md', 'README.md'])
|
||||||
|
|
||||||
|
// Fail if not a book
|
||||||
|
.then(function(isBook) {
|
||||||
|
if(!isBook) {
|
||||||
|
return Q.reject(new Error("Invalid gitbook repository, need SUMMARY.md and README.md"));
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// Clean output folder
|
||||||
|
.then(function() {
|
||||||
|
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
|
||||||
|
return options.github;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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() {
|
.then(function() {
|
||||||
return fs.mkdirp(options.output);
|
return fs.mkdirp(options.output);
|
||||||
@@ -67,104 +231,67 @@ var generate = function(options) {
|
|||||||
return fs.list(options.input)
|
return fs.list(options.input)
|
||||||
.then(function(_files) {
|
.then(function(_files) {
|
||||||
files = _files;
|
files = _files;
|
||||||
|
});
|
||||||
|
})
|
||||||
|
|
||||||
|
.then(function() {
|
||||||
|
return loadGenerator(options);
|
||||||
|
})
|
||||||
|
|
||||||
|
// Convert files
|
||||||
|
.then(function(generator) {
|
||||||
|
// Generate the book
|
||||||
|
return Q()
|
||||||
|
|
||||||
|
// Get summary
|
||||||
|
.then(function() {
|
||||||
|
return fs.readFile(path.join(options.input, "SUMMARY.md"), "utf-8")
|
||||||
|
.then(function(_summary) {
|
||||||
|
options.summary = parse.summary(_summary);
|
||||||
|
|
||||||
|
// Parse navigation
|
||||||
|
options.navigation = parse.navigation(options.summary);
|
||||||
|
});
|
||||||
})
|
})
|
||||||
})
|
|
||||||
|
|
||||||
// Create the generator
|
// Skip processing some files
|
||||||
.then(function() {
|
.then(function() {
|
||||||
generator = new generators[options.generator](options);
|
files = _.filter(files, function (file) {
|
||||||
})
|
return !(
|
||||||
|
file === 'SUMMARY.md'
|
||||||
// Detect multi-languages book
|
|
||||||
.then(function() {
|
|
||||||
if (_.contains(files, "LANGS.md")) {
|
|
||||||
// Multi-languages book
|
|
||||||
return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
|
|
||||||
|
|
||||||
// Generate sub-books
|
|
||||||
.then(function(_langsSummary) {
|
|
||||||
options.langsSummary = parse.langs(_langsSummary);
|
|
||||||
|
|
||||||
// Generated a book for each valid entry
|
|
||||||
return Q.all(
|
|
||||||
_.map(options.langsSummary.list, function(entry) {
|
|
||||||
return generate(_.extend({}, options, {
|
|
||||||
input: path.join(options.input, entry.path),
|
|
||||||
output: path.join(options.output, entry.path)
|
|
||||||
}));
|
|
||||||
})
|
|
||||||
);
|
);
|
||||||
})
|
|
||||||
|
|
||||||
// Generate languages index
|
|
||||||
.then(function() {
|
|
||||||
return generator.langsIndex(options.langsSummary);
|
|
||||||
});
|
});
|
||||||
} else if (!_.contains(files, "SUMMARY.md") || !_.contains(files, "README.md")) {
|
})
|
||||||
// Invalid book
|
|
||||||
return Q.reject(new Error("Invalid gitbook repository, need SUMMARY.md and README.md"));
|
|
||||||
} else {
|
|
||||||
// Generate the book
|
|
||||||
return Q()
|
|
||||||
|
|
||||||
// Read readme
|
// Copy file and replace markdown file
|
||||||
.then(function() {
|
.then(function() {
|
||||||
return fs.readFile(path.join(options.input, "README.md"), "utf-8")
|
return Q.all(
|
||||||
.then(function(_readme) {
|
_.chain(files)
|
||||||
_readme = parse.readme(_readme);
|
.map(function(file) {
|
||||||
|
if (!file) return;
|
||||||
|
|
||||||
options.title = options.title || _readme.title;
|
if (file[file.length -1] == "/") {
|
||||||
options.description = options.description || _readme.description || defaultDescription;
|
return Q(generator.transferFolder(file));
|
||||||
});
|
} else if (path.extname(file) == ".md" && options.navigation[file] != null) {
|
||||||
})
|
return fs.readFile(path.join(options.input, file), "utf-8")
|
||||||
|
.then(function(content) {
|
||||||
|
return Q(generator.convertFile(content, file));
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
return Q(generator.transferFile(file));
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.value()
|
||||||
|
);
|
||||||
|
})
|
||||||
|
|
||||||
// Get summary
|
// Finish generation
|
||||||
.then(function() {
|
.then(function() {
|
||||||
return fs.readFile(path.join(options.input, "SUMMARY.md"), "utf-8")
|
return generator.finish();
|
||||||
.then(function(_summary) {
|
})
|
||||||
options.summary = parse.summary(_summary);
|
.then(function() {
|
||||||
|
return generator.callHook("finish");
|
||||||
// Parse navigation
|
});
|
||||||
options.navigation = parse.navigation(options.summary);
|
|
||||||
});
|
|
||||||
})
|
|
||||||
|
|
||||||
// Skip processing some files
|
|
||||||
.then(function() {
|
|
||||||
files = _.filter(files, function (file) {
|
|
||||||
return !(
|
|
||||||
file === 'SUMMARY.md'
|
|
||||||
);
|
|
||||||
});
|
|
||||||
})
|
|
||||||
|
|
||||||
// Copy file and replace markdown file
|
|
||||||
.then(function() {
|
|
||||||
return Q.all(
|
|
||||||
_.chain(files)
|
|
||||||
.map(function(file) {
|
|
||||||
if (!file) return;
|
|
||||||
|
|
||||||
if (file[file.length -1] == "/") {
|
|
||||||
return Q(generator.transferFolder(file));
|
|
||||||
} else if (path.extname(file) == ".md" && options.navigation[file] != null) {
|
|
||||||
return fs.readFile(path.join(options.input, file), "utf-8")
|
|
||||||
.then(function(content) {
|
|
||||||
return Q(generator.convertFile(content, file));
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
return Q(generator.transferFile(file));
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.value()
|
|
||||||
);
|
|
||||||
})
|
|
||||||
|
|
||||||
// Finish gneration
|
|
||||||
.then(function() {
|
|
||||||
return generator.finish();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Return all options
|
// Return all options
|
||||||
@@ -234,5 +361,7 @@ var generateFile = function(options) {
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
generators: generators,
|
generators: generators,
|
||||||
folder: generate,
|
folder: generate,
|
||||||
file: generateFile
|
file: generateFile,
|
||||||
|
book: generateBook,
|
||||||
|
Plugin: Plugin,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
var util = require("util");
|
var util = require("util");
|
||||||
var path = require("path");
|
var path = require("path");
|
||||||
var Q = require("q");
|
var Q = require("q");
|
||||||
|
var _ = require("lodash");
|
||||||
|
|
||||||
var fs = require("../fs");
|
var fs = require("../fs");
|
||||||
var parse = require("../../parse");
|
var parse = require("../../parse");
|
||||||
@@ -40,6 +41,35 @@ Generator.prototype.convertFile = function(content, input) {
|
|||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Generate languages index
|
||||||
|
// Contains the first languages readme and langs infos
|
||||||
|
Generator.prototype.langsIndex = function(langs) {
|
||||||
|
var that = this;
|
||||||
|
|
||||||
|
if (langs.list.length == 0) return Q.reject("Need at least one language");
|
||||||
|
|
||||||
|
var mainLang = _.first(langs.list).lang;
|
||||||
|
console.log("Main language is", mainLang);
|
||||||
|
|
||||||
|
return Q()
|
||||||
|
.then(function() {
|
||||||
|
return fs.readFile(
|
||||||
|
path.join(that.options.output, mainLang, "README.json")
|
||||||
|
);
|
||||||
|
})
|
||||||
|
.then(function(content) {
|
||||||
|
var json = JSON.parse(content);
|
||||||
|
_.extend(json, {
|
||||||
|
langs: langs.list
|
||||||
|
});
|
||||||
|
|
||||||
|
return fs.writeFile(
|
||||||
|
path.join(that.options.output, "README.json"),
|
||||||
|
JSON.stringify(json, null, 4)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
Generator.prototype.finish = function() {
|
Generator.prototype.finish = function() {
|
||||||
// ignore
|
// ignore
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,72 @@
|
|||||||
|
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;
|
||||||
@@ -25,14 +25,18 @@ swig.setFilter('code', function(code, lang) {
|
|||||||
var Generator = function() {
|
var Generator = function() {
|
||||||
BaseGenerator.apply(this, arguments);
|
BaseGenerator.apply(this, arguments);
|
||||||
|
|
||||||
// Load base template
|
|
||||||
this.template = swig.compileFile(path.resolve(this.options.theme, 'templates/page.html'));
|
|
||||||
|
|
||||||
// List of pages content
|
// List of pages content
|
||||||
this.pages = {};
|
this.pages = {};
|
||||||
};
|
};
|
||||||
util.inherits(Generator, BaseGenerator);
|
util.inherits(Generator, BaseGenerator);
|
||||||
|
|
||||||
|
// Load all templates
|
||||||
|
Generator.prototype.loadTemplates = function() {
|
||||||
|
this.template = swig.compileFile(
|
||||||
|
this.plugins.template("page") || path.resolve(this.options.theme, 'templates/page.html')
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
Generator.prototype.convertFile = function(content, input) {
|
Generator.prototype.convertFile = function(content, input) {
|
||||||
var that = this;
|
var that = this;
|
||||||
var json = {
|
var json = {
|
||||||
@@ -46,6 +50,7 @@ Generator.prototype.convertFile = function(content, input) {
|
|||||||
repo: that.options.githubId,
|
repo: that.options.githubId,
|
||||||
dir: path.dirname(input) || '/',
|
dir: path.dirname(input) || '/',
|
||||||
outdir: './',
|
outdir: './',
|
||||||
|
singleFile: true
|
||||||
});
|
});
|
||||||
})
|
})
|
||||||
.then(function(sections) {
|
.then(function(sections) {
|
||||||
|
|||||||
@@ -0,0 +1,207 @@
|
|||||||
|
var _ = require("lodash");
|
||||||
|
var Q = require("q");
|
||||||
|
var semver = require("semver");
|
||||||
|
var path = require("path");
|
||||||
|
var url = require("url");
|
||||||
|
var fs = require("./fs");
|
||||||
|
var resolve = require('resolve');
|
||||||
|
|
||||||
|
var pkg = require("../../package.json");
|
||||||
|
|
||||||
|
var RESOURCES = ["js", "css"];
|
||||||
|
|
||||||
|
var Plugin = function(name, root) {
|
||||||
|
this.name = name;
|
||||||
|
this.root = root;
|
||||||
|
this.packageInfos = {};
|
||||||
|
this.infos = {};
|
||||||
|
|
||||||
|
_.each([
|
||||||
|
"gitbook-plugin-"+name,
|
||||||
|
"gitbook-theme-"+name,
|
||||||
|
"gitbook-"+name,
|
||||||
|
name,
|
||||||
|
], function(_name) {
|
||||||
|
if (this.load(_name, __dirname)) return false;
|
||||||
|
if (this.load(_name, path.resolve(root))) return false;
|
||||||
|
}, this);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Load from a name
|
||||||
|
Plugin.prototype.load = function(name, baseDir) {
|
||||||
|
try {
|
||||||
|
var res = resolve.sync(name+"/package.json", { basedir: baseDir });
|
||||||
|
|
||||||
|
this.baseDir = path.dirname(res);
|
||||||
|
this.packageInfos = require(res);
|
||||||
|
this.infos = require(resolve.sync(name, { basedir: baseDir }));
|
||||||
|
this.name = name;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
} catch (e) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return resources
|
||||||
|
Plugin.prototype.getResources = function(resource) {
|
||||||
|
if (!this.infos.book || !this.infos.book[resource]) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
return _.chain(this.infos.book[resource])
|
||||||
|
.map(function(resource) {
|
||||||
|
var parsed = url.parse(resource);
|
||||||
|
if (parsed.protocol) return {"url": resource}
|
||||||
|
else return { "path": this.name+"/"+resource };
|
||||||
|
}.bind(this))
|
||||||
|
.value();
|
||||||
|
};
|
||||||
|
|
||||||
|
// Test if it's a valid plugin
|
||||||
|
Plugin.prototype.isValid = function() {
|
||||||
|
return (
|
||||||
|
this.packageInfos
|
||||||
|
&& this.packageInfos.name
|
||||||
|
&& this.packageInfos.engines
|
||||||
|
&& this.packageInfos.engines.gitbook
|
||||||
|
&& semver.satisfies(pkg.version, this.packageInfos.engines.gitbook)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Resolve file path
|
||||||
|
Plugin.prototype.resolveFile = function(filename) {
|
||||||
|
return path.resolve(this.baseDir, filename);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Resolve file path
|
||||||
|
Plugin.prototype.callHook = function(name, context, data) {
|
||||||
|
var hookFunc = this.infos.hooks? this.infos.hooks[name] : null;
|
||||||
|
data = data || {};
|
||||||
|
|
||||||
|
if (!hookFunc) return Q(data);
|
||||||
|
|
||||||
|
return Q()
|
||||||
|
.then(function() {
|
||||||
|
return hookFunc.apply(context, [data]);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Has assets
|
||||||
|
Plugin.prototype.hasAssets = function(out) {
|
||||||
|
return (this.infos.book && this.infos.book.assets);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Copy plugin assets fodler
|
||||||
|
Plugin.prototype.copyAssets = function(out) {
|
||||||
|
if (!this.hasAssets()) return Q();
|
||||||
|
return fs.copy(
|
||||||
|
this.resolveFile(this.infos.book.assets),
|
||||||
|
out
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Normalize a list of plugin name to use
|
||||||
|
Plugin.normalizeNames = function(names) {
|
||||||
|
// Normalize list to an array
|
||||||
|
names = _.isString(names) ? names.split(",") : (names || []);
|
||||||
|
|
||||||
|
// List plugins to remove
|
||||||
|
var toremove = _.chain(names)
|
||||||
|
.filter(function(name) {
|
||||||
|
return name.length > 0 && name[0] == "-";
|
||||||
|
})
|
||||||
|
.map(function(name) {
|
||||||
|
return name.slice(1)
|
||||||
|
})
|
||||||
|
.value();
|
||||||
|
|
||||||
|
// Merge with defaults
|
||||||
|
names = _.chain(names)
|
||||||
|
.concat(Plugin.defaults)
|
||||||
|
.uniq()
|
||||||
|
.value();
|
||||||
|
|
||||||
|
// Remove plugins starting with
|
||||||
|
names = _.filter(names, function(name) {
|
||||||
|
return !_.contains(toremove, name) && !(name.length > 0 && name[0] == "-");
|
||||||
|
});
|
||||||
|
|
||||||
|
return names;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Extract data from a list of plugin
|
||||||
|
Plugin.fromList = function(names, root) {
|
||||||
|
var failed = [];
|
||||||
|
|
||||||
|
// Load plugins
|
||||||
|
var plugins = _.map(names, function(name) {
|
||||||
|
var plugin = new Plugin(name, root);
|
||||||
|
if (!plugin.isValid()) failed.push(name);
|
||||||
|
return plugin;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (_.size(failed) > 0) return Q.reject(new Error("Error loading plugins: "+failed.join(",")));
|
||||||
|
|
||||||
|
// Get all resources
|
||||||
|
var resources = _.chain(RESOURCES)
|
||||||
|
.map(function(resource) {
|
||||||
|
return [
|
||||||
|
resource,
|
||||||
|
_.chain(plugins)
|
||||||
|
.map(function(plugin) {
|
||||||
|
return plugin.getResources(resource);
|
||||||
|
})
|
||||||
|
.flatten()
|
||||||
|
.value()
|
||||||
|
];
|
||||||
|
})
|
||||||
|
.object()
|
||||||
|
.value();
|
||||||
|
resources.html = {}
|
||||||
|
|
||||||
|
_.each(plugins, function(plugin) {
|
||||||
|
var html = plugin.infos.book.html || {};
|
||||||
|
_.each(html, function(code, key) {
|
||||||
|
if (!_.isFunction(code)) code = _.constant(code);
|
||||||
|
if (!resources.html[key]) resources.html[key] = [];
|
||||||
|
resources.html[key].push(code);
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
return Q({
|
||||||
|
'list': plugins,
|
||||||
|
'resources': resources,
|
||||||
|
'hook': function(name, context, data) {
|
||||||
|
return _.reduce(plugins, function(prev, plugin) {
|
||||||
|
return prev.then(function(ret) {
|
||||||
|
return plugin.callHook(name, context, ret);
|
||||||
|
})
|
||||||
|
}, Q(data));
|
||||||
|
},
|
||||||
|
'template': function(name) {
|
||||||
|
var withTpl = _.find(plugins, function(plugin) {
|
||||||
|
return (plugin.infos.templates
|
||||||
|
&& plugin.infos.templates[name]);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!withTpl) return null;
|
||||||
|
return withTpl.resolveFile(withTpl.infos.templates[name]);
|
||||||
|
},
|
||||||
|
'html': function(tag, context, options) {
|
||||||
|
return _.map(resources.html[tag] || [], function(code) {
|
||||||
|
return code.call(context, options);
|
||||||
|
}).join("\n");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Default plugins
|
||||||
|
Plugin.defaults = [
|
||||||
|
"mixpanel",
|
||||||
|
"mathjax"
|
||||||
|
];
|
||||||
|
|
||||||
|
module.exports = Plugin;
|
||||||
+108
-14
@@ -9,6 +9,7 @@ var parse = require("../../parse");
|
|||||||
var BaseGenerator = require("../generator");
|
var BaseGenerator = require("../generator");
|
||||||
|
|
||||||
var indexer = require('./search_indexer');
|
var indexer = require('./search_indexer');
|
||||||
|
var Manifest = require('../manifest');
|
||||||
|
|
||||||
// Swig filter for returning the count of lines in a code section
|
// Swig filter for returning the count of lines in a code section
|
||||||
swig.setFilter('lines', function(content) {
|
swig.setFilter('lines', function(content) {
|
||||||
@@ -30,17 +31,39 @@ var Generator = function() {
|
|||||||
|
|
||||||
this.revision = Date.now();
|
this.revision = Date.now();
|
||||||
this.indexer = indexer();
|
this.indexer = indexer();
|
||||||
|
this.manifest = new Manifest(Date.now());
|
||||||
// Load base template
|
this.manifest.add("NETWORK", [
|
||||||
this.template = swig.compileFile(path.resolve(this.options.theme, 'templates/site.html'));
|
'*'
|
||||||
this.langsTemplate = swig.compileFile(path.resolve(this.options.theme, 'templates/langs.html'));
|
]);
|
||||||
};
|
};
|
||||||
util.inherits(Generator, BaseGenerator);
|
util.inherits(Generator, BaseGenerator);
|
||||||
|
|
||||||
|
// Load all templates
|
||||||
|
Generator.prototype.loadTemplates = function() {
|
||||||
|
this.template = swig.compileFile(
|
||||||
|
this.plugins.template("site") || path.resolve(this.options.theme, 'templates/site.html')
|
||||||
|
);
|
||||||
|
this.langsTemplate = swig.compileFile(
|
||||||
|
this.plugins.template("langs") || path.resolve(this.options.theme, 'templates/langs.html')
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Load plugins
|
||||||
|
Generator.prototype.loadPlugins = function() {
|
||||||
|
var that = this;
|
||||||
|
|
||||||
|
return BaseGenerator.prototype.loadPlugins.apply(this)
|
||||||
|
.then(function() {
|
||||||
|
return that.loadTemplates();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
// Generate a template
|
// Generate a template
|
||||||
Generator.prototype._writeTemplate = function(tpl, options, output) {
|
Generator.prototype._writeTemplate = function(tpl, options, output, interpolate) {
|
||||||
var that = this;
|
var that = this;
|
||||||
|
|
||||||
|
interpolate = interpolate || _.identity;
|
||||||
|
|
||||||
return Q()
|
return Q()
|
||||||
.then(function(sections) {
|
.then(function(sections) {
|
||||||
return tpl(_.extend({
|
return tpl(_.extend({
|
||||||
@@ -54,9 +77,16 @@ Generator.prototype._writeTemplate = function(tpl, options, output) {
|
|||||||
githubHost: that.options.githubHost,
|
githubHost: that.options.githubHost,
|
||||||
|
|
||||||
summary: that.options.summary,
|
summary: that.options.summary,
|
||||||
allNavigation: that.options.navigation
|
allNavigation: that.options.navigation,
|
||||||
|
|
||||||
|
plugins: that.plugins,
|
||||||
|
pluginsConfig: JSON.stringify(that.options.pluginsConfig),
|
||||||
|
htmlSnippet: _.partialRight(that.plugins.html, that, options),
|
||||||
|
|
||||||
|
options: that.options
|
||||||
}, options));
|
}, options));
|
||||||
})
|
})
|
||||||
|
.then(interpolate)
|
||||||
.then(function(html) {
|
.then(function(html) {
|
||||||
return fs.writeFile(
|
return fs.writeFile(
|
||||||
output,
|
output,
|
||||||
@@ -73,7 +103,6 @@ Generator.prototype.indexPage = function(lexed, pagePath) {
|
|||||||
// Convert a markdown file to html
|
// Convert a markdown file to html
|
||||||
Generator.prototype.convertFile = function(content, _input) {
|
Generator.prototype.convertFile = function(content, _input) {
|
||||||
var that = this;
|
var that = this;
|
||||||
var progress = parse.progress(this.options.navigation, _input);
|
|
||||||
|
|
||||||
_output = _input.replace(".md", ".html");
|
_output = _input.replace(".md", ".html");
|
||||||
if (_output == "README.html") _output = "index.html";
|
if (_output == "README.html") _output = "index.html";
|
||||||
@@ -82,10 +111,28 @@ Generator.prototype.convertFile = function(content, _input) {
|
|||||||
var output = path.join(this.options.output, _output);
|
var output = path.join(this.options.output, _output);
|
||||||
var basePath = path.relative(path.dirname(output), this.options.output) || ".";
|
var basePath = path.relative(path.dirname(output), this.options.output) || ".";
|
||||||
|
|
||||||
|
var page = {
|
||||||
|
path: _input,
|
||||||
|
content: content,
|
||||||
|
progress: parse.progress(this.options.navigation, _input)
|
||||||
|
};
|
||||||
|
|
||||||
|
var _callHook = function(name) {
|
||||||
|
return that.callHook(name, page)
|
||||||
|
.then(function(_page) {
|
||||||
|
page = _page;
|
||||||
|
return page;
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
return Q()
|
return Q()
|
||||||
|
.then(function() {
|
||||||
|
// Send content to plugins
|
||||||
|
return _callHook("page:before");
|
||||||
|
})
|
||||||
.then(function() {
|
.then(function() {
|
||||||
// Lex page
|
// Lex page
|
||||||
return parse.lex(content);
|
return parse.lex(page.content);
|
||||||
})
|
})
|
||||||
.then(function(lexed) {
|
.then(function(lexed) {
|
||||||
// Index page in search
|
// Index page in search
|
||||||
@@ -101,15 +148,27 @@ Generator.prototype.convertFile = function(content, _input) {
|
|||||||
});
|
});
|
||||||
})
|
})
|
||||||
.then(function(sections) {
|
.then(function(sections) {
|
||||||
|
page.sections = sections;
|
||||||
|
|
||||||
|
// Use plugin hook
|
||||||
|
return _callHook("page");
|
||||||
|
})
|
||||||
|
.then(function() {
|
||||||
|
that.manifest.add("CACHE", _output);
|
||||||
|
|
||||||
return that._writeTemplate(that.template, {
|
return that._writeTemplate(that.template, {
|
||||||
progress: progress,
|
progress: page.progress,
|
||||||
|
|
||||||
_input: _input,
|
_input: _input,
|
||||||
content: sections,
|
content: page.sections,
|
||||||
|
|
||||||
basePath: basePath,
|
basePath: basePath,
|
||||||
staticBase: path.join(basePath, "gitbook"),
|
staticBase: path.join(basePath, "gitbook"),
|
||||||
}, output);
|
}, output, function(html) {
|
||||||
|
page.content = html;
|
||||||
|
|
||||||
|
return _callHook("page:after").get("content")
|
||||||
|
});
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -134,10 +193,31 @@ Generator.prototype.langsIndex = function(langs) {
|
|||||||
Generator.prototype.copyAssets = function() {
|
Generator.prototype.copyAssets = function() {
|
||||||
var that = this;
|
var that = this;
|
||||||
|
|
||||||
|
// Copy gitbook assets
|
||||||
return fs.copy(
|
return fs.copy(
|
||||||
path.join(that.options.theme, "assets"),
|
path.join(that.options.theme, "assets"),
|
||||||
path.join(that.options.output, "gitbook")
|
path.join(that.options.output, "gitbook")
|
||||||
);
|
)
|
||||||
|
|
||||||
|
// Add to cach 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) {
|
||||||
|
if (!plugin.hasAssets()) return Q();
|
||||||
|
|
||||||
|
var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name);
|
||||||
|
return plugin.copyAssets(pluginAssets)
|
||||||
|
.then(function() {
|
||||||
|
return that.manifest.addFolder(pluginAssets, "gitbook/plugins/"+plugin.name);
|
||||||
|
});
|
||||||
|
})
|
||||||
|
);
|
||||||
|
})
|
||||||
};
|
};
|
||||||
|
|
||||||
// Dump search index to disk
|
// Dump search index to disk
|
||||||
@@ -148,9 +228,23 @@ 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() {
|
Generator.prototype.finish = function() {
|
||||||
return this.copyAssets()
|
var deferred = this.copyAssets().then(this.writeSearchIndex);
|
||||||
.then(this.writeSearchIndex);
|
|
||||||
|
if (this.options.cache !== false) {
|
||||||
|
deferred = deferred.then(this.writeCacheManifest);
|
||||||
|
}
|
||||||
|
|
||||||
|
return deferred;
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = Generator;
|
module.exports = Generator;
|
||||||
|
|||||||
@@ -0,0 +1,56 @@
|
|||||||
|
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 : _url.length;
|
||||||
|
|
||||||
|
// 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
|
||||||
|
};
|
||||||
+2
-1
@@ -5,5 +5,6 @@ module.exports = {
|
|||||||
lex: require('./lex'),
|
lex: require('./lex'),
|
||||||
progress: require('./progress'),
|
progress: require('./progress'),
|
||||||
navigation: require('./navigation'),
|
navigation: require('./navigation'),
|
||||||
readme: require('./readme')
|
readme: require('./readme'),
|
||||||
|
git: require('./git')
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ function clean(obj) {
|
|||||||
|
|
||||||
function flattenChapters(chapters) {
|
function flattenChapters(chapters) {
|
||||||
return _.reduce(chapters, function(accu, chapter) {
|
return _.reduce(chapters, function(accu, chapter) {
|
||||||
return accu.concat([clean(chapter)].concat(chapter.articles));
|
return accu.concat([clean(chapter)].concat(flattenChapters(chapter.articles)));
|
||||||
}, []);
|
}, []);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ var calculProgress = function(navigation, current) {
|
|||||||
return nav;
|
return nav;
|
||||||
})
|
})
|
||||||
.sortBy(function(nav) {
|
.sortBy(function(nav) {
|
||||||
return nav.level;
|
return parseFloat(nav.level);
|
||||||
})
|
})
|
||||||
.map(function(nav, i) {
|
.map(function(nav, i) {
|
||||||
// Calcul percent
|
// Calcul percent
|
||||||
@@ -27,7 +27,7 @@ var calculProgress = function(navigation, current) {
|
|||||||
} else if (done) {
|
} else if (done) {
|
||||||
prevPercent = nav.percent;
|
prevPercent = nav.percent;
|
||||||
}
|
}
|
||||||
|
|
||||||
return nav;
|
return nav;
|
||||||
})
|
})
|
||||||
.value();
|
.value();
|
||||||
|
|||||||
+18
-5
@@ -1,5 +1,6 @@
|
|||||||
var _ = require('lodash');
|
var _ = require('lodash');
|
||||||
var marked = require('marked');
|
var marked = require('marked');
|
||||||
|
var textRenderer = require('marked-text-renderer');
|
||||||
|
|
||||||
function extractFirstNode(nodes, nType) {
|
function extractFirstNode(nodes, nType) {
|
||||||
return _.chain(nodes)
|
return _.chain(nodes)
|
||||||
@@ -14,16 +15,28 @@ function extractFirstNode(nodes, nType) {
|
|||||||
|
|
||||||
function parseReadme(src) {
|
function parseReadme(src) {
|
||||||
var nodes, title, description;
|
var nodes, title, description;
|
||||||
|
var renderer = textRenderer();
|
||||||
|
|
||||||
// Parse content
|
// Parse content
|
||||||
nodes = marked.lexer(src);
|
nodes = marked.lexer(src);
|
||||||
|
|
||||||
var title = extractFirstNode(nodes, "heading");
|
title = extractFirstNode(nodes, "heading") || '';
|
||||||
var description = extractFirstNode(nodes, "paragraph");
|
description = extractFirstNode(nodes, "paragraph") || '';
|
||||||
|
|
||||||
|
var convert = _.compose(
|
||||||
|
function(text) {
|
||||||
|
return _.unescape(text.replace(/(\r\n|\n|\r)/gm, ""));
|
||||||
|
},
|
||||||
|
function(text) {
|
||||||
|
return marked.parse(text, _.extend({}, marked.defaults, {
|
||||||
|
renderer: renderer
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
title: title,
|
title: convert(title),
|
||||||
description: description
|
description: convert(description)
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+31
-13
@@ -1,5 +1,7 @@
|
|||||||
var url = require('url');
|
var url = require('url');
|
||||||
var inherits = require('util').inherits;
|
var inherits = require('util').inherits;
|
||||||
|
var links = require('../utils').links;
|
||||||
|
|
||||||
|
|
||||||
var path = require('path');
|
var path = require('path');
|
||||||
|
|
||||||
@@ -16,6 +18,7 @@ function GitBookRenderer(options, extra_options) {
|
|||||||
this._extra_options = extra_options;
|
this._extra_options = extra_options;
|
||||||
this.quizRowId = 0;
|
this.quizRowId = 0;
|
||||||
this.id = rendererId++;
|
this.id = rendererId++;
|
||||||
|
this.quizIndex = 0;
|
||||||
}
|
}
|
||||||
inherits(GitBookRenderer, marked.Renderer);
|
inherits(GitBookRenderer, marked.Renderer);
|
||||||
|
|
||||||
@@ -38,23 +41,38 @@ GitBookRenderer.prototype._unsanitized = function(href) {
|
|||||||
};
|
};
|
||||||
|
|
||||||
GitBookRenderer.prototype.link = function(href, title, text) {
|
GitBookRenderer.prototype.link = function(href, title, text) {
|
||||||
|
// Our "fixed" href
|
||||||
|
var _href = href;
|
||||||
|
|
||||||
// Don't build if it looks malicious
|
// Don't build if it looks malicious
|
||||||
if (this.options.sanitize && this._unsanitized(href)) {
|
if (this.options.sanitize && this._unsanitized(href)) {
|
||||||
return '';
|
return text;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Parsed version of the url
|
// Parsed version of the url
|
||||||
var parsed = url.parse(href);
|
var parsed = url.parse(href);
|
||||||
|
|
||||||
var o = this._extra_options;
|
var o = this._extra_options;
|
||||||
|
|
||||||
// Relative link, rewrite it to point to github repo
|
// Relative link, rewrite it to point to github repo
|
||||||
if(!parsed.protocol && parsed.path && parsed.path[0] != '/' && o && o.repo && o.dir) {
|
if(links.isRelative(_href)) {
|
||||||
href = url.resolve('https://github.com/' + o.repo + '/blob/', [o.dir, href].join("/"));
|
if (path.extname(_href) == ".md") {
|
||||||
parsed = url.parse(href);
|
_href = links.toAbsolute(_href, o.dir || "./", o.outdir || "./");
|
||||||
|
|
||||||
|
if (o.singleFile) {
|
||||||
|
_href = "#"+_href;
|
||||||
|
} else {
|
||||||
|
_href = _href.replace(".md", ".html");
|
||||||
|
}
|
||||||
|
} else if (o && o.repo && o.dir) {
|
||||||
|
href = url.resolve('https://github.com/' + o.repo + '/blob/', [o.dir, _href].join("/"));
|
||||||
|
parsed = url.parse(href);
|
||||||
|
_href = parsed.href;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generate HTML for link
|
// Generate HTML for link
|
||||||
var out = '<a href="' + parsed.href + '"';
|
var out = '<a href="' + _href + '"';
|
||||||
// Title if no null
|
// Title if no null
|
||||||
if (title) {
|
if (title) {
|
||||||
out += ' title="' + title + '"';
|
out += ' title="' + title + '"';
|
||||||
@@ -78,15 +96,11 @@ GitBookRenderer.prototype.image = function(href, title, text) {
|
|||||||
var o = this._extra_options;
|
var o = this._extra_options;
|
||||||
|
|
||||||
// Relative image, rewrite it depending output
|
// Relative image, rewrite it depending output
|
||||||
if(!parsed.protocol && parsed.path && parsed.path[0] != '/' && o && o.dir && o.outdir) {
|
if(links.isRelative(href) && o && o.dir && o.outdir) {
|
||||||
// o.dir: directory parent of the file currently in rendering process
|
// o.dir: directory parent of the file currently in rendering process
|
||||||
// o.outdir: directory parent from the html output
|
// o.outdir: directory parent from the html output
|
||||||
|
|
||||||
// Absolute file in source
|
_href = links.toAbsolute(_href, o.dir, o.outdir);
|
||||||
_href = path.join(o.dir, _href);
|
|
||||||
|
|
||||||
// make it relative to output
|
|
||||||
_href = path.relative(o.outdir, _href);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return GitBookRenderer.super_.prototype.image.call(this, _href, title, text);
|
return GitBookRenderer.super_.prototype.image.call(this, _href, title, text);
|
||||||
@@ -103,10 +117,14 @@ GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
|
|||||||
if (!match) {
|
if (!match) {
|
||||||
return text;
|
return text;
|
||||||
}
|
}
|
||||||
var field = "<input name='quiz-row-" + this.id + "-" + this.quizRowId + "' type='";
|
var quizIdentifier = 'quiz-row-' + this.id + '-' + this.quizRowId + '-' + this.quizIndex++;
|
||||||
|
var field = "<input name='" + quizIdentifier + "' id='" + quizIdentifier + "' type='";
|
||||||
field += match[1] === '(' ? "radio" : "checkbox";
|
field += match[1] === '(' ? "radio" : "checkbox";
|
||||||
field += match[2] === 'x' ? "' checked/>" : "'/>";
|
field += match[2] === 'x' ? "' checked/>" : "'/>";
|
||||||
return text.replace(fieldRegex, field);
|
var splittedText = text.split(fieldRegex);
|
||||||
|
var length = splittedText.length;
|
||||||
|
var label = '<label class="quiz-label" for="' + quizIdentifier + '">' + splittedText[length - 1] + '</label>';
|
||||||
|
return text.replace(fieldRegex, field).replace(splittedText[length - 1], label);
|
||||||
}
|
}
|
||||||
|
|
||||||
GitBookRenderer.prototype.tablecell = function(content, flags) {
|
GitBookRenderer.prototype.tablecell = function(content, flags) {
|
||||||
|
|||||||
@@ -82,17 +82,15 @@ function parseTitle(src, nums) {
|
|||||||
level: level,
|
level: level,
|
||||||
|
|
||||||
// Replace .md references with .html
|
// Replace .md references with .html
|
||||||
path: matches[2],
|
path: matches[2].replace(/\\/g, '/'),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseArticle(chapterNum, nodes, idx) {
|
function parseChapter(nodes, nums) {
|
||||||
return parseTitle(_.first(nodes).text, [chapterNum, idx+1]);
|
return _.extend(parseTitle(_.first(nodes).text, nums), {
|
||||||
}
|
articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), function(nodes, i) {
|
||||||
|
return parseChapter(nodes, nums.concat(i + 1));
|
||||||
function parseChapter(nodes, idx) {
|
})
|
||||||
return _.extend(parseTitle(_.first(nodes).text, [idx+1]), {
|
|
||||||
articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), parseArticle.bind(null, idx+1))
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -104,7 +102,9 @@ function parseSummary(src) {
|
|||||||
|
|
||||||
// Split out chapter sections
|
// Split out chapter sections
|
||||||
var chapters = _.chain(listSplit(chapterList, 'list_item_start', 'list_item_end'))
|
var chapters = _.chain(listSplit(chapterList, 'list_item_start', 'list_item_end'))
|
||||||
.map(parseChapter)
|
.map(function(nodes, i) {
|
||||||
|
return parseChapter(nodes, [i + 1]);
|
||||||
|
})
|
||||||
.value();
|
.value();
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
lang: require('./lang'),
|
lang: require('./lang'),
|
||||||
|
links: require('./links')
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
var url = require('url');
|
||||||
|
var path = require('path');
|
||||||
|
|
||||||
|
// Return true if the link is relative
|
||||||
|
var isRelative = function(href) {
|
||||||
|
var parsed = url.parse(href);
|
||||||
|
|
||||||
|
return !parsed.protocol && parsed.path && parsed.path[0] != '/';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Relative to absolute path
|
||||||
|
// dir: directory parent of the file currently in rendering process
|
||||||
|
// outdir: directory parent from the html output
|
||||||
|
|
||||||
|
var toAbsolute = function(_href, dir, outdir) {
|
||||||
|
// Absolute file in source
|
||||||
|
_href = path.join(dir, _href);
|
||||||
|
|
||||||
|
// make it relative to output
|
||||||
|
_href = path.relative(outdir, _href);
|
||||||
|
|
||||||
|
if (process.platform === 'win32') {
|
||||||
|
_href = _href.replace(/\\/g, '/');
|
||||||
|
}
|
||||||
|
|
||||||
|
return _href;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
isRelative: isRelative,
|
||||||
|
toAbsolute: toAbsolute
|
||||||
|
};
|
||||||
+12
-3
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "gitbook",
|
"name": "gitbook",
|
||||||
"version": "0.2.4",
|
"version": "0.4.7",
|
||||||
"homepage": "http://www.gitbook.io/",
|
"homepage": "http://www.gitbook.io/",
|
||||||
"description": "Library and cmd utility to generate GitBooks",
|
"description": "Library and cmd utility to generate GitBooks",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
@@ -16,14 +16,23 @@
|
|||||||
"commander": "2.2.0",
|
"commander": "2.2.0",
|
||||||
"fs-extra": "0.8.1",
|
"fs-extra": "0.8.1",
|
||||||
"highlight.js": "8.0.0",
|
"highlight.js": "8.0.0",
|
||||||
"tmp": "0.0.23"
|
"tmp": "0.0.23",
|
||||||
|
"semver": "2.2.1",
|
||||||
|
"gaze": "~0.5.1",
|
||||||
|
"resolve": "0.6.3",
|
||||||
|
"tiny-lr-fork": "0.0.5",
|
||||||
|
"gitbook-plugin": "0.0.2",
|
||||||
|
"gitbook-plugin-mixpanel": "0.0.2",
|
||||||
|
"gitbook-plugin-mathjax": "0.0.3",
|
||||||
|
"gitbook-plugin-livereload": "0.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"mocha": "1.18.2",
|
"mocha": "1.18.2",
|
||||||
"grunt": "~0.4.2",
|
"grunt": "~0.4.2",
|
||||||
"grunt-cli": "0.1.11",
|
"grunt-cli": "0.1.11",
|
||||||
"grunt-contrib-less": "~0.5.0",
|
"grunt-contrib-less": "~0.5.0",
|
||||||
"grunt-contrib-requirejs": "0.4.1"
|
"grunt-contrib-requirejs": "0.4.1",
|
||||||
|
"grunt-bower-install-simple": "0.9.2"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "export TESTING=true; mocha --reporter list"
|
"test": "export TESTING=true; mocha --reporter list"
|
||||||
|
|||||||
Vendored
+5
@@ -0,0 +1,5 @@
|
|||||||
|
# Nice course
|
||||||
|
|
||||||
|
Check out this other chapter [Test](test.md)
|
||||||
|
|
||||||
|
Check out this other chapter [Test](../before.md)
|
||||||
Vendored
+2
@@ -3,6 +3,8 @@
|
|||||||
* [Chapter 1](chapter-1/README.md)
|
* [Chapter 1](chapter-1/README.md)
|
||||||
* [Article 1](chapter-1/ARTICLE1.md)
|
* [Article 1](chapter-1/ARTICLE1.md)
|
||||||
* [Article 2](chapter-1/ARTICLE2.md)
|
* [Article 2](chapter-1/ARTICLE2.md)
|
||||||
|
* [article 1.2.1](chapter-1/ARTICLE-1-2-1.md)
|
||||||
|
* [article 1.2.2](chapter-1/ARTICLE-1-2-2.md)
|
||||||
* [Chapter 2](chapter-2/README.md)
|
* [Chapter 2](chapter-2/README.md)
|
||||||
* [Chapter 3](chapter-3/README.md)
|
* [Chapter 3](chapter-3/README.md)
|
||||||
* [Chapter 4](chapter-4/README.md)
|
* [Chapter 4](chapter-4/README.md)
|
||||||
|
|||||||
Vendored
+2
@@ -0,0 +1,2 @@
|
|||||||
|
# This is a test
|
||||||
|
|
||||||
Vendored
+3
@@ -0,0 +1,3 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
* [test](test.md)
|
||||||
Vendored
+1
@@ -0,0 +1 @@
|
|||||||
|
# Test
|
||||||
Vendored
+1
@@ -0,0 +1 @@
|
|||||||
|
# This should fail
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
var _ = require('lodash');
|
||||||
|
var Q = require('q');
|
||||||
|
var path = require('path');
|
||||||
|
var tmp = require('tmp');
|
||||||
|
var assert = require('assert');
|
||||||
|
|
||||||
|
var generate = require("../lib/generate");
|
||||||
|
|
||||||
|
var generateTmpBook = function(path) {
|
||||||
|
return ;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
var BOOKS = {
|
||||||
|
"book1": true,
|
||||||
|
"book2": false
|
||||||
|
};
|
||||||
|
|
||||||
|
describe('Site Generation', function () {
|
||||||
|
var ret = {};
|
||||||
|
|
||||||
|
beforeEach(function(done){
|
||||||
|
Q.all(_.map(BOOKS, function(state, bookName) {
|
||||||
|
return Q.nfcall(tmp.dir)
|
||||||
|
.then(function(_dir) {
|
||||||
|
return generate.folder({
|
||||||
|
input: path.join(__dirname, "fixtures", bookName),
|
||||||
|
output: _dir
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.then(function(_book) {
|
||||||
|
ret[bookName] = _book;
|
||||||
|
}, function(err) {
|
||||||
|
// ignore errors here
|
||||||
|
});
|
||||||
|
}))
|
||||||
|
.fin(done);
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
it('should generate the valid sites', function() {
|
||||||
|
_.each(BOOKS, function(state, bookName) {
|
||||||
|
assert((ret[bookName] != null) == state);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
+12
-2
@@ -18,6 +18,8 @@ describe('Summary navigation', function() {
|
|||||||
'chapter-1/ARTICLE1.md',
|
'chapter-1/ARTICLE1.md',
|
||||||
'chapter-1/ARTICLE2.md',
|
'chapter-1/ARTICLE2.md',
|
||||||
'chapter-2/README.md',
|
'chapter-2/README.md',
|
||||||
|
'chapter-1/ARTICLE-1-2-1.md',
|
||||||
|
'chapter-1/ARTICLE-1-2-2.md'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
// Make sure it found the files we gave it
|
// Make sure it found the files we gave it
|
||||||
@@ -26,6 +28,8 @@ describe('Summary navigation', function() {
|
|||||||
assert(nav['chapter-1/ARTICLE1.md']);
|
assert(nav['chapter-1/ARTICLE1.md']);
|
||||||
assert(nav['chapter-1/ARTICLE2.md']);
|
assert(nav['chapter-1/ARTICLE2.md']);
|
||||||
assert(nav['chapter-2/README.md']);
|
assert(nav['chapter-2/README.md']);
|
||||||
|
assert(nav['chapter-1/ARTICLE-1-2-1.md']);
|
||||||
|
assert(nav['chapter-1/ARTICLE-1-2-2.md']);
|
||||||
|
|
||||||
|
|
||||||
assert.equal(nav['README.md'].prev, null);
|
assert.equal(nav['README.md'].prev, null);
|
||||||
@@ -38,9 +42,15 @@ describe('Summary navigation', function() {
|
|||||||
assert.equal(nav['chapter-1/ARTICLE1.md'].next.path, 'chapter-1/ARTICLE2.md');
|
assert.equal(nav['chapter-1/ARTICLE1.md'].next.path, 'chapter-1/ARTICLE2.md');
|
||||||
|
|
||||||
assert.equal(nav['chapter-1/ARTICLE2.md'].prev.path, 'chapter-1/ARTICLE1.md');
|
assert.equal(nav['chapter-1/ARTICLE2.md'].prev.path, 'chapter-1/ARTICLE1.md');
|
||||||
assert.equal(nav['chapter-1/ARTICLE2.md'].next.path, 'chapter-2/README.md');
|
assert.equal(nav['chapter-1/ARTICLE2.md'].next.path, 'chapter-1/ARTICLE-1-2-1.md');
|
||||||
|
|
||||||
assert.equal(nav['chapter-2/README.md'].prev.path, 'chapter-1/ARTICLE2.md');
|
assert.equal(nav['chapter-1/ARTICLE-1-2-1.md'].prev.path, 'chapter-1/ARTICLE2.md');
|
||||||
|
assert.equal(nav['chapter-1/ARTICLE-1-2-1.md'].next.path, 'chapter-1/ARTICLE-1-2-2.md');
|
||||||
|
|
||||||
|
assert.equal(nav['chapter-1/ARTICLE-1-2-2.md'].prev.path, 'chapter-1/ARTICLE-1-2-1.md');
|
||||||
|
assert.equal(nav['chapter-1/ARTICLE-1-2-2.md'].next.path, 'chapter-2/README.md');
|
||||||
|
|
||||||
|
assert.equal(nav['chapter-2/README.md'].prev.path, 'chapter-1/ARTICLE-1-2-2.md');
|
||||||
assert.equal(nav['chapter-2/README.md'].next.path, 'chapter-3/README.md');
|
assert.equal(nav['chapter-2/README.md'].next.path, 'chapter-3/README.md');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
+31
-1
@@ -84,11 +84,41 @@ describe('Relative links', function() {
|
|||||||
repo: 'GitBookIO/javascript',
|
repo: 'GitBookIO/javascript',
|
||||||
|
|
||||||
// Imaginary folder of markdown file
|
// Imaginary folder of markdown file
|
||||||
dir: 'course'
|
dir: 'course',
|
||||||
|
outdir: './'
|
||||||
});
|
});
|
||||||
|
|
||||||
assert(LEXED[0].content.indexOf('https://github.com/GitBookIO/javascript/blob/src/something.cpp') !== -1);
|
assert(LEXED[0].content.indexOf('https://github.com/GitBookIO/javascript/blob/src/something.cpp') !== -1);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should replace link to .md by link to .html', function() {
|
||||||
|
var LEXED = loadPage('MARKDOWN_LINKS', {
|
||||||
|
// GitHub repo ID
|
||||||
|
repo: 'GitBookIO/javascript',
|
||||||
|
|
||||||
|
// Imaginary folder of markdown file
|
||||||
|
dir: 'course',
|
||||||
|
outdir: 'course'
|
||||||
|
});
|
||||||
|
|
||||||
|
assert(LEXED[0].content.indexOf('test.html') !== -1);
|
||||||
|
assert(LEXED[0].content.indexOf('../before.html') !== -1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should replace link to .md by link to page in format single page', function() {
|
||||||
|
var LEXED = loadPage('MARKDOWN_LINKS', {
|
||||||
|
// GitHub repo ID
|
||||||
|
repo: 'GitBookIO/javascript',
|
||||||
|
|
||||||
|
// Imaginary folder of markdown file
|
||||||
|
dir: 'course',
|
||||||
|
outdir: './',
|
||||||
|
singleFile: true
|
||||||
|
});
|
||||||
|
|
||||||
|
assert(LEXED[0].content.indexOf('#course/test.md') !== -1);
|
||||||
|
assert(LEXED[0].content.indexOf('#before.md') !== -1);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('Relative images', function() {
|
describe('Relative images', function() {
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
var _ = require('lodash');
|
||||||
|
var path = require('path');
|
||||||
|
var assert = require('assert');
|
||||||
|
|
||||||
|
var Plugin = require('../').generate.Plugin;
|
||||||
|
|
||||||
|
describe('Plugin validation', function () {
|
||||||
|
var plugin = new Plugin("plugin", __dirname);
|
||||||
|
|
||||||
|
it('should be valid', function() {
|
||||||
|
assert(plugin.isValid());
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('Plugin list of names', function () {
|
||||||
|
var firstDefault = _.first(Plugin.defaults);
|
||||||
|
|
||||||
|
it('should convert string to array', function() {
|
||||||
|
var _name = "test";
|
||||||
|
assert(_.contains(Plugin.normalizeNames(_name), _name));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should contains default plugins', function() {
|
||||||
|
assert(_.contains(Plugin.normalizeNames([]), firstDefault));
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should remove name starting with -', function() {
|
||||||
|
assert(!_.contains(Plugin.normalizeNames(["-"+firstDefault]), firstDefault));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('Plugin defaults loading', function () {
|
||||||
|
var ret = true;
|
||||||
|
|
||||||
|
beforeEach(function(done){
|
||||||
|
Plugin.fromList(Plugin.defaults, __dirname)
|
||||||
|
.then(function(_r) {
|
||||||
|
ret = _r;
|
||||||
|
}, function(err) {
|
||||||
|
ret = null;
|
||||||
|
})
|
||||||
|
.fin(done);
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
it('should load defaults addons', function() {
|
||||||
|
assert(ret != null);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -50,5 +50,6 @@ describe('Summary parsing', function () {
|
|||||||
|
|
||||||
assert.equal(c[0].articles[0].level, '1.1');
|
assert.equal(c[0].articles[0].level, '1.1');
|
||||||
assert.equal(c[0].articles[1].level, '1.2');
|
assert.equal(c[0].articles[1].level, '1.2');
|
||||||
|
assert.equal(c[0].articles[1].articles[0].level, '1.2.1');
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
# GitBook Theme
|
|
||||||
|
|
||||||
For creating a theme for GitBook, just copy this folder. The theme folder should at least contains two folders: `assets` and `templates`.
|
|
||||||
|
|
||||||
The theme can be changed using the option ```--theme=<path>```
|
|
||||||
|
|
||||||
#### Warning! Theme system is going to change before version 1.0.0
|
|
||||||
+1
-1
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,7 @@
|
|||||||
|
define([
|
||||||
|
"jQuery"
|
||||||
|
], function($) {
|
||||||
|
var events = $({});
|
||||||
|
|
||||||
|
return events;
|
||||||
|
});
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
define([
|
define([
|
||||||
"jQuery",
|
"jQuery",
|
||||||
"utils/execute",
|
"utils/execute",
|
||||||
"utils/analytic",
|
"core/events",
|
||||||
"core/state"
|
"core/state"
|
||||||
], function($, execute, analytic, state){
|
], function($, execute, events, state){
|
||||||
// Bind an exercise
|
// Bind an exercise
|
||||||
var prepareExercise = function($exercise) {
|
var prepareExercise = function($exercise) {
|
||||||
var codeSolution = $exercise.find(".code-solution").text();
|
var codeSolution = $exercise.find(".code-solution").text();
|
||||||
@@ -19,7 +19,7 @@ define([
|
|||||||
$exercise.find(".action-submit").click(function(e) {
|
$exercise.find(".action-submit").click(function(e) {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
|
|
||||||
analytic.track("exercise.submit", {type: "code"});
|
events.trigger("exercise.submit", {type: "code"});
|
||||||
|
|
||||||
execute("javascript", editor.getValue(), codeValidation, codeContext, function(err, result) {
|
execute("javascript", editor.getValue(), codeValidation, codeContext, function(err, result) {
|
||||||
$exercise.toggleClass("return-error", err != null);
|
$exercise.toggleClass("return-error", err != null);
|
||||||
|
|||||||
@@ -0,0 +1,121 @@
|
|||||||
|
define([
|
||||||
|
"jQuery",
|
||||||
|
"utils/storage"
|
||||||
|
], function($, storage) {
|
||||||
|
var fontState;
|
||||||
|
|
||||||
|
var THEMES = {
|
||||||
|
"white": 0,
|
||||||
|
"sepia": 1,
|
||||||
|
"night": 2
|
||||||
|
};
|
||||||
|
|
||||||
|
var FAMILY = {
|
||||||
|
"serif": 0,
|
||||||
|
"sans": 1
|
||||||
|
};
|
||||||
|
|
||||||
|
var togglePopover = function(e) {
|
||||||
|
var $dropdown = $("#font-settings-wrapper .dropdown-menu");
|
||||||
|
|
||||||
|
$dropdown.toggleClass("open");
|
||||||
|
e.stopPropagation();
|
||||||
|
e.preventDefault();
|
||||||
|
};
|
||||||
|
|
||||||
|
var closePopover = function(e) {
|
||||||
|
var $dropdown = $("#font-settings-wrapper .dropdown-menu");
|
||||||
|
|
||||||
|
$dropdown.removeClass("open");
|
||||||
|
};
|
||||||
|
|
||||||
|
var enlargeFontSize = function(e){
|
||||||
|
if (fontState.size < 4){
|
||||||
|
fontState.size++;
|
||||||
|
fontState.save();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var reduceFontSize = function(e){
|
||||||
|
if (fontState.size > 0){
|
||||||
|
fontState.size--;
|
||||||
|
fontState.save();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var changeFontFamily = function(){
|
||||||
|
var index = $(this).data("font");
|
||||||
|
|
||||||
|
fontState.family = index;
|
||||||
|
fontState.save();
|
||||||
|
};
|
||||||
|
|
||||||
|
var changeColorTheme = function(){
|
||||||
|
var $book = $(".book");
|
||||||
|
var index = $(this).data("theme");
|
||||||
|
|
||||||
|
if (fontState.theme !== 0)
|
||||||
|
$book.removeClass("color-theme-"+fontState.theme);
|
||||||
|
|
||||||
|
fontState.theme = index;
|
||||||
|
if (fontState.theme !== 0)
|
||||||
|
$book.addClass("color-theme-"+fontState.theme);
|
||||||
|
|
||||||
|
fontState.save();
|
||||||
|
};
|
||||||
|
|
||||||
|
var update = function() {
|
||||||
|
var $book = $(".book");
|
||||||
|
|
||||||
|
$(".font-settings .font-family-list li").removeClass("active");
|
||||||
|
$(".font-settings .font-family-list li:nth-child("+(fontState.family+1)+")").addClass("active");
|
||||||
|
|
||||||
|
$book[0].className = $book[0].className.replace(/\bfont-\S+/g, '');
|
||||||
|
$book.addClass("font-size-"+fontState.size);
|
||||||
|
$book.addClass("font-family-"+fontState.family);
|
||||||
|
|
||||||
|
if(fontState.theme !== 0) {
|
||||||
|
$book[0].className = $book[0].className.replace(/\bcolor-theme-\S+/g, '');
|
||||||
|
$book.addClass("color-theme-"+fontState.theme);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var init = function(config) {
|
||||||
|
var $toggle, $bookBody, $dropdown, $book;
|
||||||
|
|
||||||
|
//Find DOM elements.
|
||||||
|
$book = $(".book");
|
||||||
|
$toggle = $(".book-header .toggle-font-settings");
|
||||||
|
$dropdown = $("#font-settings-wrapper .dropdown-menu");
|
||||||
|
$bookBody = $(".book-body");
|
||||||
|
|
||||||
|
// Instantiate font state object
|
||||||
|
fontState = storage.get("fontState", {
|
||||||
|
size: config.size || 1,
|
||||||
|
family: FAMILY[config.family || "serif"],
|
||||||
|
theme: THEMES[config.theme || "white"]
|
||||||
|
});
|
||||||
|
fontState.save = function(){
|
||||||
|
storage.set("fontState",fontState);
|
||||||
|
update();
|
||||||
|
};
|
||||||
|
|
||||||
|
update();
|
||||||
|
|
||||||
|
//Add event listeners
|
||||||
|
$(document).on('click', "#enlarge-font-size", enlargeFontSize);
|
||||||
|
$(document).on('click', "#reduce-font-size", reduceFontSize);
|
||||||
|
|
||||||
|
$(document).on('click', "#font-settings-wrapper .font-family-list li", changeFontFamily);
|
||||||
|
$(document).on('click', "#font-settings-wrapper .color-theme-list button", changeColorTheme);
|
||||||
|
|
||||||
|
$(document).on('click', ".book-header .toggle-font-settings", togglePopover);
|
||||||
|
$(document).on('click', "#font-settings-wrapper .dropdown-menu", function(e){ e.stopPropagation(); });
|
||||||
|
$(document).on("click", closePopover);
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
init: init,
|
||||||
|
update: update
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
define([
|
||||||
|
"jQuery"
|
||||||
|
], function($) {
|
||||||
|
var showLoading = function(p) {
|
||||||
|
$(".book").addClass("is-loading");
|
||||||
|
p.always(function() {
|
||||||
|
$(".book").removeClass("is-loading");
|
||||||
|
});
|
||||||
|
|
||||||
|
return p;
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
show: showLoading
|
||||||
|
};
|
||||||
|
});
|
||||||
@@ -1,38 +1,41 @@
|
|||||||
define([
|
define([
|
||||||
"jQuery",
|
"jQuery",
|
||||||
"utils/analytic",
|
"utils/url",
|
||||||
|
"core/events",
|
||||||
"core/state",
|
"core/state",
|
||||||
"core/search",
|
|
||||||
"core/progress",
|
"core/progress",
|
||||||
"core/exercise",
|
"core/exercise",
|
||||||
"core/quiz"
|
"core/quiz",
|
||||||
], function($, analytic, state, search, progress, exercises, quiz) {
|
"core/loading"
|
||||||
|
], function($, URL, events, state, progress, exercises, quiz, loading) {
|
||||||
var prev, next;
|
var prev, next;
|
||||||
var githubCountStars, githubCountWatch;
|
var githubCountStars, githubCountWatch;
|
||||||
|
|
||||||
var usePushState = !navigator.userAgent.match('CriOS') && (typeof history.pushState !== "undefined");
|
var usePushState = (typeof history.pushState !== "undefined");
|
||||||
|
|
||||||
var updateHistory = function(url, title) {
|
var handleNavigation = function(relativeUrl, push) {
|
||||||
history.pushState({ path: url }, title, url);
|
var url = URL.join(window.location.pathname, relativeUrl);
|
||||||
};
|
console.log("navigate to ", url, "baseurl="+relativeUrl, "current="+window.location.pathname);
|
||||||
|
|
||||||
var handleNavigation = function(url, push) {
|
|
||||||
if (!usePushState) {
|
if (!usePushState) {
|
||||||
// Refresh the page to the new URL if pushState not supported
|
// Refresh the page to the new URL if pushState not supported
|
||||||
location.href = url;
|
location.href = relativeUrl;
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
return $.get(url)
|
return loading.show($.get(url)
|
||||||
.done(function (html) {
|
.done(function (html) {
|
||||||
if (push) updateHistory(url, null);
|
// Push url to history
|
||||||
|
if (push) history.pushState({ path: url }, null, url);
|
||||||
|
|
||||||
|
// Replace html content
|
||||||
html = html.replace( /<(\/?)(html|head|body)([^>]*)>/ig, function(a,b,c,d){
|
html = html.replace( /<(\/?)(html|head|body)([^>]*)>/ig, function(a,b,c,d){
|
||||||
return '<' + b + 'div' + ( b ? '' : ' data-element="' + c + '"' ) + d + '>';
|
return '<' + b + 'div' + ( b ? '' : ' data-element="' + c + '"' ) + d + '>';
|
||||||
});
|
});
|
||||||
|
|
||||||
var $page = $(html);
|
var $page = $(html);
|
||||||
var $pageHead = $page.find("[data-element=head]");
|
var $pageHead = $page.find("[data-element=head]");
|
||||||
|
var $pageBody = $page.find('.book');
|
||||||
|
|
||||||
// Merge heads
|
// Merge heads
|
||||||
var headContent = $pageHead.html()
|
var headContent = $pageHead.html()
|
||||||
@@ -42,22 +45,22 @@ define([
|
|||||||
});
|
});
|
||||||
$("head").html(headContent);
|
$("head").html(headContent);
|
||||||
|
|
||||||
// Update header, body
|
// Merge body
|
||||||
$('.book-header').html($page.find('.book-header').html());
|
var bodyClass = $(".book").attr("class");
|
||||||
$('.book-body').html($page.find('.book-body').html());
|
|
||||||
|
|
||||||
// Update summary
|
|
||||||
var scrollPosition = $('.book-summary .summary').scrollTop();
|
var scrollPosition = $('.book-summary .summary').scrollTop();
|
||||||
$('.book-summary').html($page.find('.book-summary').html());
|
$pageBody.toggleClass("with-summary", $(".book").hasClass("with-summary"))
|
||||||
|
|
||||||
|
$(".book").replaceWith($pageBody);
|
||||||
|
$(".book").attr("class", bodyClass);
|
||||||
$('.book-summary .summary').scrollTop(scrollPosition);
|
$('.book-summary .summary').scrollTop(scrollPosition);
|
||||||
|
|
||||||
// Update state
|
// Update state
|
||||||
state.update($("html"));
|
state.update($("html"));
|
||||||
preparePage();
|
preparePage();
|
||||||
})
|
})
|
||||||
.fail(function () {
|
.fail(function (e) {
|
||||||
location.href = url;
|
location.href = relativeUrl;
|
||||||
});
|
}));
|
||||||
};
|
};
|
||||||
|
|
||||||
var updateGitHubCounts = function() {
|
var updateGitHubCounts = function() {
|
||||||
@@ -92,9 +95,6 @@ define([
|
|||||||
// Focus on content
|
// Focus on content
|
||||||
$pageWrapper.focus();
|
$pageWrapper.focus();
|
||||||
|
|
||||||
// Prepare search bar
|
|
||||||
search.prepare();
|
|
||||||
|
|
||||||
// Update GitHub count
|
// Update GitHub count
|
||||||
if (state.githubId) {
|
if (state.githubId) {
|
||||||
if (githubCountStars) {
|
if (githubCountStars) {
|
||||||
@@ -110,7 +110,7 @@ define([
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Send to mixpanel
|
// Send to mixpanel
|
||||||
analytic.track("page.view");
|
events.trigger("page.change");
|
||||||
};
|
};
|
||||||
|
|
||||||
var handlePagination = function (e) {
|
var handlePagination = function (e) {
|
||||||
@@ -131,7 +131,7 @@ define([
|
|||||||
if (url) handleNavigation(url, true);
|
if (url) handleNavigation(url, true);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
var init = function() {
|
var init = function() {
|
||||||
// Prevent cache so that using the back button works
|
// Prevent cache so that using the back button works
|
||||||
@@ -148,14 +148,13 @@ define([
|
|||||||
if (event.state === null) {
|
if (event.state === null) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
return handleNavigation(event.state.path, false);
|
return handleNavigation(event.state.path, false);
|
||||||
};
|
};
|
||||||
|
|
||||||
$(document).on('click', ".navigation-prev", handlePagination);
|
$(document).on('click', ".navigation-prev", handlePagination);
|
||||||
$(document).on('click', ".navigation-next", handlePagination);
|
$(document).on('click', ".navigation-next", handlePagination);
|
||||||
$(document).on('click', ".summary [data-path] a", handlePagination);
|
$(document).on('click', ".summary [data-path] a", handlePagination);
|
||||||
|
|
||||||
$(window).resize(updateNavigationPosition);
|
$(window).resize(updateNavigationPosition);
|
||||||
|
|
||||||
// Prepare current page
|
// Prepare current page
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
define([
|
define([
|
||||||
"jQuery",
|
"jQuery",
|
||||||
"utils/execute",
|
"utils/execute",
|
||||||
"utils/analytic",
|
"core/events",
|
||||||
"core/state"
|
"core/state"
|
||||||
], function($, execute, analytic, state){
|
], function($, execute, events, state){
|
||||||
// Bind an exercise
|
// Bind an exercise
|
||||||
var prepareQuiz = function($quiz) {
|
var prepareQuiz = function($quiz) {
|
||||||
|
|
||||||
@@ -14,7 +14,7 @@ define([
|
|||||||
// Submit: test code
|
// Submit: test code
|
||||||
$quiz.find(".action-submit").click(function(e) {
|
$quiz.find(".action-submit").click(function(e) {
|
||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
analytic.track("exercise.submit", {type: "quiz"});
|
events.trigger("exercise.submit", {type: "quiz"});
|
||||||
$quiz.find("tr.alert-danger,li.alert-danger").removeClass("alert-danger");
|
$quiz.find("tr.alert-danger,li.alert-danger").removeClass("alert-danger");
|
||||||
$quiz.find(".alert-success,.alert-danger").addClass("hidden");
|
$quiz.find(".alert-success,.alert-danger").addClass("hidden");
|
||||||
|
|
||||||
|
|||||||
@@ -67,12 +67,10 @@ define([
|
|||||||
e.preventDefault();
|
e.preventDefault();
|
||||||
toggleSearch();
|
toggleSearch();
|
||||||
});
|
});
|
||||||
};
|
|
||||||
|
|
||||||
var prepare = function() {
|
|
||||||
var $searchInput = $(".book-search input");
|
|
||||||
|
|
||||||
$searchInput.keyup(function(e) {
|
// Type in search bar
|
||||||
|
$(document).on("keyup", ".book-search input", function(e) {
|
||||||
var key = (e.keyCode ? e.keyCode : e.which);
|
var key = (e.keyCode ? e.keyCode : e.which);
|
||||||
var q = $(this).val();
|
var q = $(this).val();
|
||||||
|
|
||||||
@@ -89,13 +87,12 @@ define([
|
|||||||
_.pluck(results, "path")
|
_.pluck(results, "path")
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
});
|
})
|
||||||
}
|
};
|
||||||
|
|
||||||
return {
|
return {
|
||||||
init: init,
|
init: init,
|
||||||
search: search,
|
search: search,
|
||||||
toggle: toggleSearch,
|
toggle: toggleSearch
|
||||||
prepare: prepare
|
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
define([
|
define([
|
||||||
|
"jQuery",
|
||||||
"lodash",
|
"lodash",
|
||||||
"utils/storage",
|
"utils/storage",
|
||||||
"utils/platform",
|
"utils/platform",
|
||||||
"core/state"
|
"core/state"
|
||||||
], function(_, storage, platform, state) {
|
], function($, _, storage, platform, state) {
|
||||||
var $summary = state.$book.find(".book-summary");
|
|
||||||
|
|
||||||
// Toggle sidebar with or withour animation
|
// Toggle sidebar with or withour animation
|
||||||
var toggleSidebar = function(_state, animation) {
|
var toggleSidebar = function(_state, animation) {
|
||||||
if (state != null && isOpen() == _state) return;
|
if (state != null && isOpen() == _state) return;
|
||||||
@@ -38,6 +37,8 @@ define([
|
|||||||
|
|
||||||
// Filter summary with a list of path
|
// Filter summary with a list of path
|
||||||
var filterSummary = function(paths) {
|
var filterSummary = function(paths) {
|
||||||
|
var $summary = $(".book-summary");
|
||||||
|
|
||||||
$summary.find("li").each(function() {
|
$summary.find("li").each(function() {
|
||||||
var path = $(this).data("path");
|
var path = $(this).data("path");
|
||||||
var st = paths == null || _.contains(paths, path);
|
var st = paths == null || _.contains(paths, path);
|
||||||
@@ -48,7 +49,6 @@ define([
|
|||||||
};
|
};
|
||||||
|
|
||||||
return {
|
return {
|
||||||
$el: $summary,
|
|
||||||
init: init,
|
init: init,
|
||||||
toggle: toggleSidebar,
|
toggle: toggleSidebar,
|
||||||
filter: filterSummary
|
filter: filterSummary
|
||||||
|
|||||||
@@ -1,17 +1,19 @@
|
|||||||
require([
|
define([
|
||||||
"jQuery",
|
"jQuery",
|
||||||
"utils/storage",
|
"utils/storage",
|
||||||
"utils/analytic",
|
|
||||||
"utils/sharing",
|
"utils/sharing",
|
||||||
|
"utils/appcache",
|
||||||
|
|
||||||
|
"core/events",
|
||||||
|
"core/font-settings",
|
||||||
"core/state",
|
"core/state",
|
||||||
"core/keyboard",
|
"core/keyboard",
|
||||||
"core/navigation",
|
"core/navigation",
|
||||||
"core/progress",
|
"core/progress",
|
||||||
"core/sidebar",
|
"core/sidebar",
|
||||||
"core/search"
|
"core/search"
|
||||||
], function($, storage, analytic, sharing, state, keyboard, navigation, progress, sidebar, search){
|
], function($, storage, appCache, sharing, events, fontSettings, state, keyboard, navigation, progress, sidebar, search){
|
||||||
$(document).ready(function() {
|
var start = function(config) {
|
||||||
var $book;
|
var $book;
|
||||||
$book = state.$book;
|
$book = state.$book;
|
||||||
|
|
||||||
@@ -29,10 +31,23 @@ require([
|
|||||||
// Init keyboard
|
// Init keyboard
|
||||||
keyboard.init();
|
keyboard.init();
|
||||||
|
|
||||||
|
// Init appcache
|
||||||
|
appCache.init();
|
||||||
|
|
||||||
// Bind sharing button
|
// Bind sharing button
|
||||||
sharing.init();
|
sharing.init();
|
||||||
|
|
||||||
// Init navigation
|
// Init navigation
|
||||||
navigation.init();
|
navigation.init();
|
||||||
});
|
|
||||||
|
//Init font settings
|
||||||
|
fontSettings.init(config.fontSettings || {});
|
||||||
|
|
||||||
|
events.trigger("start", config);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
start: start,
|
||||||
|
events: events
|
||||||
|
};
|
||||||
});
|
});
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
define([
|
|
||||||
"lodash"
|
|
||||||
], function(_) {
|
|
||||||
var isAvailable = function() {
|
|
||||||
return (
|
|
||||||
typeof mixpanel !== "undefined" &&
|
|
||||||
typeof mixpanel.track === "function"
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
var track = function(e, data, t) {
|
|
||||||
if (!isAvailable()) {
|
|
||||||
console.warn("tracking not available!");
|
|
||||||
t = t || 500;
|
|
||||||
setTimeout(function() {
|
|
||||||
console.log(" -> retest tracking");
|
|
||||||
track(e, data, t*2);
|
|
||||||
}, t);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.log("track", e);
|
|
||||||
mixpanel.track(e, _.extend(data || {}, {
|
|
||||||
'domain': window.location.host
|
|
||||||
}));
|
|
||||||
};
|
|
||||||
|
|
||||||
setTimeout(function() {
|
|
||||||
mixpanel.init("01eb2b950ae09a5fdb15a98dcc5ff20e");
|
|
||||||
track("page.start");
|
|
||||||
}, 0);
|
|
||||||
|
|
||||||
return {
|
|
||||||
isAvailable: isAvailable,
|
|
||||||
track: track
|
|
||||||
};
|
|
||||||
});
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
define([], function() {
|
||||||
|
var isAvailable = (typeof applicationCache !== "undefined");
|
||||||
|
|
||||||
|
var init = function() {
|
||||||
|
if (!isAvailable) return;
|
||||||
|
|
||||||
|
window.applicationCache.addEventListener('updateready', function() {
|
||||||
|
window.location.reload();
|
||||||
|
}, false);
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
init: init
|
||||||
|
};
|
||||||
|
});
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
define([
|
||||||
|
"vendors/URIjs/src/URI"
|
||||||
|
], function(URI) {
|
||||||
|
// Joins path segments. Preserves initial "/" and resolves ".." and "."
|
||||||
|
// Does not support using ".." to go above/outside the root.
|
||||||
|
// This means that join("foo", "../../bar") will not resolve to "../bar"
|
||||||
|
function join(baseUrl, url) {
|
||||||
|
var theUrl = new URI(url);
|
||||||
|
if (theUrl.is("relative")) {
|
||||||
|
theUrl = theUrl.absoluteTo(baseUrl);
|
||||||
|
}
|
||||||
|
return theUrl.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
// A simple function to get the dirname of a path
|
||||||
|
// Trailing slashes are ignored. Leading slash is preserved.
|
||||||
|
function dirname(path) {
|
||||||
|
return join(path, "..");
|
||||||
|
}
|
||||||
|
|
||||||
|
// test if a path or url is absolute
|
||||||
|
function isAbsolute(path) {
|
||||||
|
if (!path) return false;
|
||||||
|
|
||||||
|
return (path[0] == "/" || path.indexOf("http://") == 0 || path.indexOf("https://") == 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
dirname: dirname,
|
||||||
|
join: join,
|
||||||
|
isAbsolute: isAbsolute
|
||||||
|
};
|
||||||
|
})
|
||||||
Vendored
-9111
File diff suppressed because it is too large
Load Diff
Vendored
-6785
File diff suppressed because it is too large
Load Diff
-953
@@ -1,953 +0,0 @@
|
|||||||
/*global define:false */
|
|
||||||
/**
|
|
||||||
* Copyright 2013 Craig Campbell
|
|
||||||
*
|
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
* you may not use this file except in compliance with the License.
|
|
||||||
* You may obtain a copy of the License at
|
|
||||||
*
|
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
*
|
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
* See the License for the specific language governing permissions and
|
|
||||||
* limitations under the License.
|
|
||||||
*
|
|
||||||
* Mousetrap is a simple keyboard shortcut library for Javascript with
|
|
||||||
* no external dependencies
|
|
||||||
*
|
|
||||||
* @version 1.4.6
|
|
||||||
* @url craig.is/killing/mice
|
|
||||||
*/
|
|
||||||
(function(window, document, undefined) {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* mapping of special keycodes to their corresponding keys
|
|
||||||
*
|
|
||||||
* everything in this dictionary cannot use keypress events
|
|
||||||
* so it has to be here to map to the correct keycodes for
|
|
||||||
* keyup/keydown events
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
var _MAP = {
|
|
||||||
8: 'backspace',
|
|
||||||
9: 'tab',
|
|
||||||
13: 'enter',
|
|
||||||
16: 'shift',
|
|
||||||
17: 'ctrl',
|
|
||||||
18: 'alt',
|
|
||||||
20: 'capslock',
|
|
||||||
27: 'esc',
|
|
||||||
32: 'space',
|
|
||||||
33: 'pageup',
|
|
||||||
34: 'pagedown',
|
|
||||||
35: 'end',
|
|
||||||
36: 'home',
|
|
||||||
37: 'left',
|
|
||||||
38: 'up',
|
|
||||||
39: 'right',
|
|
||||||
40: 'down',
|
|
||||||
45: 'ins',
|
|
||||||
46: 'del',
|
|
||||||
91: 'meta',
|
|
||||||
93: 'meta',
|
|
||||||
224: 'meta'
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* mapping for special characters so they can support
|
|
||||||
*
|
|
||||||
* this dictionary is only used incase you want to bind a
|
|
||||||
* keyup or keydown event to one of these keys
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_KEYCODE_MAP = {
|
|
||||||
106: '*',
|
|
||||||
107: '+',
|
|
||||||
109: '-',
|
|
||||||
110: '.',
|
|
||||||
111 : '/',
|
|
||||||
186: ';',
|
|
||||||
187: '=',
|
|
||||||
188: ',',
|
|
||||||
189: '-',
|
|
||||||
190: '.',
|
|
||||||
191: '/',
|
|
||||||
192: '`',
|
|
||||||
219: '[',
|
|
||||||
220: '\\',
|
|
||||||
221: ']',
|
|
||||||
222: '\''
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* this is a mapping of keys that require shift on a US keypad
|
|
||||||
* back to the non shift equivelents
|
|
||||||
*
|
|
||||||
* this is so you can use keyup events with these keys
|
|
||||||
*
|
|
||||||
* note that this will only work reliably on US keyboards
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_SHIFT_MAP = {
|
|
||||||
'~': '`',
|
|
||||||
'!': '1',
|
|
||||||
'@': '2',
|
|
||||||
'#': '3',
|
|
||||||
'$': '4',
|
|
||||||
'%': '5',
|
|
||||||
'^': '6',
|
|
||||||
'&': '7',
|
|
||||||
'*': '8',
|
|
||||||
'(': '9',
|
|
||||||
')': '0',
|
|
||||||
'_': '-',
|
|
||||||
'+': '=',
|
|
||||||
':': ';',
|
|
||||||
'\"': '\'',
|
|
||||||
'<': ',',
|
|
||||||
'>': '.',
|
|
||||||
'?': '/',
|
|
||||||
'|': '\\'
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* this is a list of special strings you can use to map
|
|
||||||
* to modifier keys when you specify your keyboard shortcuts
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_SPECIAL_ALIASES = {
|
|
||||||
'option': 'alt',
|
|
||||||
'command': 'meta',
|
|
||||||
'return': 'enter',
|
|
||||||
'escape': 'esc',
|
|
||||||
'mod': /Mac|iPod|iPhone|iPad/.test(navigator.platform) ? 'meta' : 'ctrl'
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* variable to store the flipped version of _MAP from above
|
|
||||||
* needed to check if we should use keypress or not when no action
|
|
||||||
* is specified
|
|
||||||
*
|
|
||||||
* @type {Object|undefined}
|
|
||||||
*/
|
|
||||||
_REVERSE_MAP,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* a list of all the callbacks setup via Mousetrap.bind()
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_callbacks = {},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* direct map of string combinations to callbacks used for trigger()
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_directMap = {},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* keeps track of what level each sequence is at since multiple
|
|
||||||
* sequences can start out with the same sequence
|
|
||||||
*
|
|
||||||
* @type {Object}
|
|
||||||
*/
|
|
||||||
_sequenceLevels = {},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* variable to store the setTimeout call
|
|
||||||
*
|
|
||||||
* @type {null|number}
|
|
||||||
*/
|
|
||||||
_resetTimer,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* temporary state where we will ignore the next keyup
|
|
||||||
*
|
|
||||||
* @type {boolean|string}
|
|
||||||
*/
|
|
||||||
_ignoreNextKeyup = false,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* temporary state where we will ignore the next keypress
|
|
||||||
*
|
|
||||||
* @type {boolean}
|
|
||||||
*/
|
|
||||||
_ignoreNextKeypress = false,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* are we currently inside of a sequence?
|
|
||||||
* type of action ("keyup" or "keydown" or "keypress") or false
|
|
||||||
*
|
|
||||||
* @type {boolean|string}
|
|
||||||
*/
|
|
||||||
_nextExpectedAction = false;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* loop through the f keys, f1 to f19 and add them to the map
|
|
||||||
* programatically
|
|
||||||
*/
|
|
||||||
for (var i = 1; i < 20; ++i) {
|
|
||||||
_MAP[111 + i] = 'f' + i;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* loop through to map numbers on the numeric keypad
|
|
||||||
*/
|
|
||||||
for (i = 0; i <= 9; ++i) {
|
|
||||||
_MAP[i + 96] = i;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* cross browser add event method
|
|
||||||
*
|
|
||||||
* @param {Element|HTMLDocument} object
|
|
||||||
* @param {string} type
|
|
||||||
* @param {Function} callback
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _addEvent(object, type, callback) {
|
|
||||||
if (object.addEventListener) {
|
|
||||||
object.addEventListener(type, callback, false);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
object.attachEvent('on' + type, callback);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* takes the event and returns the key character
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @return {string}
|
|
||||||
*/
|
|
||||||
function _characterFromEvent(e) {
|
|
||||||
|
|
||||||
// for keypress events we should return the character as is
|
|
||||||
if (e.type == 'keypress') {
|
|
||||||
var character = String.fromCharCode(e.which);
|
|
||||||
|
|
||||||
// if the shift key is not pressed then it is safe to assume
|
|
||||||
// that we want the character to be lowercase. this means if
|
|
||||||
// you accidentally have caps lock on then your key bindings
|
|
||||||
// will continue to work
|
|
||||||
//
|
|
||||||
// the only side effect that might not be desired is if you
|
|
||||||
// bind something like 'A' cause you want to trigger an
|
|
||||||
// event when capital A is pressed caps lock will no longer
|
|
||||||
// trigger the event. shift+a will though.
|
|
||||||
if (!e.shiftKey) {
|
|
||||||
character = character.toLowerCase();
|
|
||||||
}
|
|
||||||
|
|
||||||
return character;
|
|
||||||
}
|
|
||||||
|
|
||||||
// for non keypress events the special maps are needed
|
|
||||||
if (_MAP[e.which]) {
|
|
||||||
return _MAP[e.which];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_KEYCODE_MAP[e.which]) {
|
|
||||||
return _KEYCODE_MAP[e.which];
|
|
||||||
}
|
|
||||||
|
|
||||||
// if it is not in the special map
|
|
||||||
|
|
||||||
// with keydown and keyup events the character seems to always
|
|
||||||
// come in as an uppercase character whether you are pressing shift
|
|
||||||
// or not. we should make sure it is always lowercase for comparisons
|
|
||||||
return String.fromCharCode(e.which).toLowerCase();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* checks if two arrays are equal
|
|
||||||
*
|
|
||||||
* @param {Array} modifiers1
|
|
||||||
* @param {Array} modifiers2
|
|
||||||
* @returns {boolean}
|
|
||||||
*/
|
|
||||||
function _modifiersMatch(modifiers1, modifiers2) {
|
|
||||||
return modifiers1.sort().join(',') === modifiers2.sort().join(',');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* resets all sequence counters except for the ones passed in
|
|
||||||
*
|
|
||||||
* @param {Object} doNotReset
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _resetSequences(doNotReset) {
|
|
||||||
doNotReset = doNotReset || {};
|
|
||||||
|
|
||||||
var activeSequences = false,
|
|
||||||
key;
|
|
||||||
|
|
||||||
for (key in _sequenceLevels) {
|
|
||||||
if (doNotReset[key]) {
|
|
||||||
activeSequences = true;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
_sequenceLevels[key] = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!activeSequences) {
|
|
||||||
_nextExpectedAction = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* finds all callbacks that match based on the keycode, modifiers,
|
|
||||||
* and action
|
|
||||||
*
|
|
||||||
* @param {string} character
|
|
||||||
* @param {Array} modifiers
|
|
||||||
* @param {Event|Object} e
|
|
||||||
* @param {string=} sequenceName - name of the sequence we are looking for
|
|
||||||
* @param {string=} combination
|
|
||||||
* @param {number=} level
|
|
||||||
* @returns {Array}
|
|
||||||
*/
|
|
||||||
function _getMatches(character, modifiers, e, sequenceName, combination, level) {
|
|
||||||
var i,
|
|
||||||
callback,
|
|
||||||
matches = [],
|
|
||||||
action = e.type;
|
|
||||||
|
|
||||||
// if there are no events related to this keycode
|
|
||||||
if (!_callbacks[character]) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
// if a modifier key is coming up on its own we should allow it
|
|
||||||
if (action == 'keyup' && _isModifier(character)) {
|
|
||||||
modifiers = [character];
|
|
||||||
}
|
|
||||||
|
|
||||||
// loop through all callbacks for the key that was pressed
|
|
||||||
// and see if any of them match
|
|
||||||
for (i = 0; i < _callbacks[character].length; ++i) {
|
|
||||||
callback = _callbacks[character][i];
|
|
||||||
|
|
||||||
// if a sequence name is not specified, but this is a sequence at
|
|
||||||
// the wrong level then move onto the next match
|
|
||||||
if (!sequenceName && callback.seq && _sequenceLevels[callback.seq] != callback.level) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the action we are looking for doesn't match the action we got
|
|
||||||
// then we should keep going
|
|
||||||
if (action != callback.action) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// if this is a keypress event and the meta key and control key
|
|
||||||
// are not pressed that means that we need to only look at the
|
|
||||||
// character, otherwise check the modifiers as well
|
|
||||||
//
|
|
||||||
// chrome will not fire a keypress if meta or control is down
|
|
||||||
// safari will fire a keypress if meta or meta+shift is down
|
|
||||||
// firefox will fire a keypress if meta or control is down
|
|
||||||
if ((action == 'keypress' && !e.metaKey && !e.ctrlKey) || _modifiersMatch(modifiers, callback.modifiers)) {
|
|
||||||
|
|
||||||
// when you bind a combination or sequence a second time it
|
|
||||||
// should overwrite the first one. if a sequenceName or
|
|
||||||
// combination is specified in this call it does just that
|
|
||||||
//
|
|
||||||
// @todo make deleting its own method?
|
|
||||||
var deleteCombo = !sequenceName && callback.combo == combination;
|
|
||||||
var deleteSequence = sequenceName && callback.seq == sequenceName && callback.level == level;
|
|
||||||
if (deleteCombo || deleteSequence) {
|
|
||||||
_callbacks[character].splice(i, 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
matches.push(callback);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return matches;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* takes a key event and figures out what the modifiers are
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns {Array}
|
|
||||||
*/
|
|
||||||
function _eventModifiers(e) {
|
|
||||||
var modifiers = [];
|
|
||||||
|
|
||||||
if (e.shiftKey) {
|
|
||||||
modifiers.push('shift');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (e.altKey) {
|
|
||||||
modifiers.push('alt');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (e.ctrlKey) {
|
|
||||||
modifiers.push('ctrl');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (e.metaKey) {
|
|
||||||
modifiers.push('meta');
|
|
||||||
}
|
|
||||||
|
|
||||||
return modifiers;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* prevents default for this event
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _preventDefault(e) {
|
|
||||||
if (e.preventDefault) {
|
|
||||||
e.preventDefault();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
e.returnValue = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* stops propogation for this event
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _stopPropagation(e) {
|
|
||||||
if (e.stopPropagation) {
|
|
||||||
e.stopPropagation();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
e.cancelBubble = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* actually calls the callback function
|
|
||||||
*
|
|
||||||
* if your callback function returns false this will use the jquery
|
|
||||||
* convention - prevent default and stop propogation on the event
|
|
||||||
*
|
|
||||||
* @param {Function} callback
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _fireCallback(callback, e, combo, sequence) {
|
|
||||||
|
|
||||||
// if this event should not happen stop here
|
|
||||||
if (Mousetrap.stopCallback(e, e.target || e.srcElement, combo, sequence)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (callback(e, combo) === false) {
|
|
||||||
_preventDefault(e);
|
|
||||||
_stopPropagation(e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* handles a character key event
|
|
||||||
*
|
|
||||||
* @param {string} character
|
|
||||||
* @param {Array} modifiers
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _handleKey(character, modifiers, e) {
|
|
||||||
var callbacks = _getMatches(character, modifiers, e),
|
|
||||||
i,
|
|
||||||
doNotReset = {},
|
|
||||||
maxLevel = 0,
|
|
||||||
processedSequenceCallback = false;
|
|
||||||
|
|
||||||
// Calculate the maxLevel for sequences so we can only execute the longest callback sequence
|
|
||||||
for (i = 0; i < callbacks.length; ++i) {
|
|
||||||
if (callbacks[i].seq) {
|
|
||||||
maxLevel = Math.max(maxLevel, callbacks[i].level);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// loop through matching callbacks for this key event
|
|
||||||
for (i = 0; i < callbacks.length; ++i) {
|
|
||||||
|
|
||||||
// fire for all sequence callbacks
|
|
||||||
// this is because if for example you have multiple sequences
|
|
||||||
// bound such as "g i" and "g t" they both need to fire the
|
|
||||||
// callback for matching g cause otherwise you can only ever
|
|
||||||
// match the first one
|
|
||||||
if (callbacks[i].seq) {
|
|
||||||
|
|
||||||
// only fire callbacks for the maxLevel to prevent
|
|
||||||
// subsequences from also firing
|
|
||||||
//
|
|
||||||
// for example 'a option b' should not cause 'option b' to fire
|
|
||||||
// even though 'option b' is part of the other sequence
|
|
||||||
//
|
|
||||||
// any sequences that do not match here will be discarded
|
|
||||||
// below by the _resetSequences call
|
|
||||||
if (callbacks[i].level != maxLevel) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
processedSequenceCallback = true;
|
|
||||||
|
|
||||||
// keep a list of which sequences were matches for later
|
|
||||||
doNotReset[callbacks[i].seq] = 1;
|
|
||||||
_fireCallback(callbacks[i].callback, e, callbacks[i].combo, callbacks[i].seq);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// if there were no sequence matches but we are still here
|
|
||||||
// that means this is a regular match so we should fire that
|
|
||||||
if (!processedSequenceCallback) {
|
|
||||||
_fireCallback(callbacks[i].callback, e, callbacks[i].combo);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the key you pressed matches the type of sequence without
|
|
||||||
// being a modifier (ie "keyup" or "keypress") then we should
|
|
||||||
// reset all sequences that were not matched by this event
|
|
||||||
//
|
|
||||||
// this is so, for example, if you have the sequence "h a t" and you
|
|
||||||
// type "h e a r t" it does not match. in this case the "e" will
|
|
||||||
// cause the sequence to reset
|
|
||||||
//
|
|
||||||
// modifier keys are ignored because you can have a sequence
|
|
||||||
// that contains modifiers such as "enter ctrl+space" and in most
|
|
||||||
// cases the modifier key will be pressed before the next key
|
|
||||||
//
|
|
||||||
// also if you have a sequence such as "ctrl+b a" then pressing the
|
|
||||||
// "b" key will trigger a "keypress" and a "keydown"
|
|
||||||
//
|
|
||||||
// the "keydown" is expected when there is a modifier, but the
|
|
||||||
// "keypress" ends up matching the _nextExpectedAction since it occurs
|
|
||||||
// after and that causes the sequence to reset
|
|
||||||
//
|
|
||||||
// we ignore keypresses in a sequence that directly follow a keydown
|
|
||||||
// for the same character
|
|
||||||
var ignoreThisKeypress = e.type == 'keypress' && _ignoreNextKeypress;
|
|
||||||
if (e.type == _nextExpectedAction && !_isModifier(character) && !ignoreThisKeypress) {
|
|
||||||
_resetSequences(doNotReset);
|
|
||||||
}
|
|
||||||
|
|
||||||
_ignoreNextKeypress = processedSequenceCallback && e.type == 'keydown';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* handles a keydown event
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _handleKeyEvent(e) {
|
|
||||||
|
|
||||||
// normalize e.which for key events
|
|
||||||
// @see http://stackoverflow.com/questions/4285627/javascript-keycode-vs-charcode-utter-confusion
|
|
||||||
if (typeof e.which !== 'number') {
|
|
||||||
e.which = e.keyCode;
|
|
||||||
}
|
|
||||||
|
|
||||||
var character = _characterFromEvent(e);
|
|
||||||
|
|
||||||
// no character found then stop
|
|
||||||
if (!character) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// need to use === for the character check because the character can be 0
|
|
||||||
if (e.type == 'keyup' && _ignoreNextKeyup === character) {
|
|
||||||
_ignoreNextKeyup = false;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
Mousetrap.handleKey(character, _eventModifiers(e), e);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* determines if the keycode specified is a modifier key or not
|
|
||||||
*
|
|
||||||
* @param {string} key
|
|
||||||
* @returns {boolean}
|
|
||||||
*/
|
|
||||||
function _isModifier(key) {
|
|
||||||
return key == 'shift' || key == 'ctrl' || key == 'alt' || key == 'meta';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* called to set a 1 second timeout on the specified sequence
|
|
||||||
*
|
|
||||||
* this is so after each key press in the sequence you have 1 second
|
|
||||||
* to press the next key before you have to start over
|
|
||||||
*
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _resetSequenceTimer() {
|
|
||||||
clearTimeout(_resetTimer);
|
|
||||||
_resetTimer = setTimeout(_resetSequences, 1000);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* reverses the map lookup so that we can look for specific keys
|
|
||||||
* to see what can and can't use keypress
|
|
||||||
*
|
|
||||||
* @return {Object}
|
|
||||||
*/
|
|
||||||
function _getReverseMap() {
|
|
||||||
if (!_REVERSE_MAP) {
|
|
||||||
_REVERSE_MAP = {};
|
|
||||||
for (var key in _MAP) {
|
|
||||||
|
|
||||||
// pull out the numeric keypad from here cause keypress should
|
|
||||||
// be able to detect the keys from the character
|
|
||||||
if (key > 95 && key < 112) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (_MAP.hasOwnProperty(key)) {
|
|
||||||
_REVERSE_MAP[_MAP[key]] = key;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return _REVERSE_MAP;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* picks the best action based on the key combination
|
|
||||||
*
|
|
||||||
* @param {string} key - character for key
|
|
||||||
* @param {Array} modifiers
|
|
||||||
* @param {string=} action passed in
|
|
||||||
*/
|
|
||||||
function _pickBestAction(key, modifiers, action) {
|
|
||||||
|
|
||||||
// if no action was picked in we should try to pick the one
|
|
||||||
// that we think would work best for this key
|
|
||||||
if (!action) {
|
|
||||||
action = _getReverseMap()[key] ? 'keydown' : 'keypress';
|
|
||||||
}
|
|
||||||
|
|
||||||
// modifier keys don't work as expected with keypress,
|
|
||||||
// switch to keydown
|
|
||||||
if (action == 'keypress' && modifiers.length) {
|
|
||||||
action = 'keydown';
|
|
||||||
}
|
|
||||||
|
|
||||||
return action;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* binds a key sequence to an event
|
|
||||||
*
|
|
||||||
* @param {string} combo - combo specified in bind call
|
|
||||||
* @param {Array} keys
|
|
||||||
* @param {Function} callback
|
|
||||||
* @param {string=} action
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _bindSequence(combo, keys, callback, action) {
|
|
||||||
|
|
||||||
// start off by adding a sequence level record for this combination
|
|
||||||
// and setting the level to 0
|
|
||||||
_sequenceLevels[combo] = 0;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* callback to increase the sequence level for this sequence and reset
|
|
||||||
* all other sequences that were active
|
|
||||||
*
|
|
||||||
* @param {string} nextAction
|
|
||||||
* @returns {Function}
|
|
||||||
*/
|
|
||||||
function _increaseSequence(nextAction) {
|
|
||||||
return function() {
|
|
||||||
_nextExpectedAction = nextAction;
|
|
||||||
++_sequenceLevels[combo];
|
|
||||||
_resetSequenceTimer();
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* wraps the specified callback inside of another function in order
|
|
||||||
* to reset all sequence counters as soon as this sequence is done
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _callbackAndReset(e) {
|
|
||||||
_fireCallback(callback, e, combo);
|
|
||||||
|
|
||||||
// we should ignore the next key up if the action is key down
|
|
||||||
// or keypress. this is so if you finish a sequence and
|
|
||||||
// release the key the final key will not trigger a keyup
|
|
||||||
if (action !== 'keyup') {
|
|
||||||
_ignoreNextKeyup = _characterFromEvent(e);
|
|
||||||
}
|
|
||||||
|
|
||||||
// weird race condition if a sequence ends with the key
|
|
||||||
// another sequence begins with
|
|
||||||
setTimeout(_resetSequences, 10);
|
|
||||||
}
|
|
||||||
|
|
||||||
// loop through keys one at a time and bind the appropriate callback
|
|
||||||
// function. for any key leading up to the final one it should
|
|
||||||
// increase the sequence. after the final, it should reset all sequences
|
|
||||||
//
|
|
||||||
// if an action is specified in the original bind call then that will
|
|
||||||
// be used throughout. otherwise we will pass the action that the
|
|
||||||
// next key in the sequence should match. this allows a sequence
|
|
||||||
// to mix and match keypress and keydown events depending on which
|
|
||||||
// ones are better suited to the key provided
|
|
||||||
for (var i = 0; i < keys.length; ++i) {
|
|
||||||
var isFinal = i + 1 === keys.length;
|
|
||||||
var wrappedCallback = isFinal ? _callbackAndReset : _increaseSequence(action || _getKeyInfo(keys[i + 1]).action);
|
|
||||||
_bindSingle(keys[i], wrappedCallback, action, combo, i);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Converts from a string key combination to an array
|
|
||||||
*
|
|
||||||
* @param {string} combination like "command+shift+l"
|
|
||||||
* @return {Array}
|
|
||||||
*/
|
|
||||||
function _keysFromString(combination) {
|
|
||||||
if (combination === '+') {
|
|
||||||
return ['+'];
|
|
||||||
}
|
|
||||||
|
|
||||||
return combination.split('+');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets info for a specific key combination
|
|
||||||
*
|
|
||||||
* @param {string} combination key combination ("command+s" or "a" or "*")
|
|
||||||
* @param {string=} action
|
|
||||||
* @returns {Object}
|
|
||||||
*/
|
|
||||||
function _getKeyInfo(combination, action) {
|
|
||||||
var keys,
|
|
||||||
key,
|
|
||||||
i,
|
|
||||||
modifiers = [];
|
|
||||||
|
|
||||||
// take the keys from this pattern and figure out what the actual
|
|
||||||
// pattern is all about
|
|
||||||
keys = _keysFromString(combination);
|
|
||||||
|
|
||||||
for (i = 0; i < keys.length; ++i) {
|
|
||||||
key = keys[i];
|
|
||||||
|
|
||||||
// normalize key names
|
|
||||||
if (_SPECIAL_ALIASES[key]) {
|
|
||||||
key = _SPECIAL_ALIASES[key];
|
|
||||||
}
|
|
||||||
|
|
||||||
// if this is not a keypress event then we should
|
|
||||||
// be smart about using shift keys
|
|
||||||
// this will only work for US keyboards however
|
|
||||||
if (action && action != 'keypress' && _SHIFT_MAP[key]) {
|
|
||||||
key = _SHIFT_MAP[key];
|
|
||||||
modifiers.push('shift');
|
|
||||||
}
|
|
||||||
|
|
||||||
// if this key is a modifier then add it to the list of modifiers
|
|
||||||
if (_isModifier(key)) {
|
|
||||||
modifiers.push(key);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// depending on what the key combination is
|
|
||||||
// we will try to pick the best event for it
|
|
||||||
action = _pickBestAction(key, modifiers, action);
|
|
||||||
|
|
||||||
return {
|
|
||||||
key: key,
|
|
||||||
modifiers: modifiers,
|
|
||||||
action: action
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* binds a single keyboard combination
|
|
||||||
*
|
|
||||||
* @param {string} combination
|
|
||||||
* @param {Function} callback
|
|
||||||
* @param {string=} action
|
|
||||||
* @param {string=} sequenceName - name of sequence if part of sequence
|
|
||||||
* @param {number=} level - what part of the sequence the command is
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _bindSingle(combination, callback, action, sequenceName, level) {
|
|
||||||
|
|
||||||
// store a direct mapped reference for use with Mousetrap.trigger
|
|
||||||
_directMap[combination + ':' + action] = callback;
|
|
||||||
|
|
||||||
// make sure multiple spaces in a row become a single space
|
|
||||||
combination = combination.replace(/\s+/g, ' ');
|
|
||||||
|
|
||||||
var sequence = combination.split(' '),
|
|
||||||
info;
|
|
||||||
|
|
||||||
// if this pattern is a sequence of keys then run through this method
|
|
||||||
// to reprocess each pattern one key at a time
|
|
||||||
if (sequence.length > 1) {
|
|
||||||
_bindSequence(combination, sequence, callback, action);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
info = _getKeyInfo(combination, action);
|
|
||||||
|
|
||||||
// make sure to initialize array if this is the first time
|
|
||||||
// a callback is added for this key
|
|
||||||
_callbacks[info.key] = _callbacks[info.key] || [];
|
|
||||||
|
|
||||||
// remove an existing match if there is one
|
|
||||||
_getMatches(info.key, info.modifiers, {type: info.action}, sequenceName, combination, level);
|
|
||||||
|
|
||||||
// add this call back to the array
|
|
||||||
// if it is a sequence put it at the beginning
|
|
||||||
// if not put it at the end
|
|
||||||
//
|
|
||||||
// this is important because the way these are processed expects
|
|
||||||
// the sequence ones to come first
|
|
||||||
_callbacks[info.key][sequenceName ? 'unshift' : 'push']({
|
|
||||||
callback: callback,
|
|
||||||
modifiers: info.modifiers,
|
|
||||||
action: info.action,
|
|
||||||
seq: sequenceName,
|
|
||||||
level: level,
|
|
||||||
combo: combination
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* binds multiple combinations to the same callback
|
|
||||||
*
|
|
||||||
* @param {Array} combinations
|
|
||||||
* @param {Function} callback
|
|
||||||
* @param {string|undefined} action
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
function _bindMultiple(combinations, callback, action) {
|
|
||||||
for (var i = 0; i < combinations.length; ++i) {
|
|
||||||
_bindSingle(combinations[i], callback, action);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// start!
|
|
||||||
_addEvent(document, 'keypress', _handleKeyEvent);
|
|
||||||
_addEvent(document, 'keydown', _handleKeyEvent);
|
|
||||||
_addEvent(document, 'keyup', _handleKeyEvent);
|
|
||||||
|
|
||||||
var Mousetrap = {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* binds an event to mousetrap
|
|
||||||
*
|
|
||||||
* can be a single key, a combination of keys separated with +,
|
|
||||||
* an array of keys, or a sequence of keys separated by spaces
|
|
||||||
*
|
|
||||||
* be sure to list the modifier keys first to make sure that the
|
|
||||||
* correct key ends up getting bound (the last key in the pattern)
|
|
||||||
*
|
|
||||||
* @param {string|Array} keys
|
|
||||||
* @param {Function} callback
|
|
||||||
* @param {string=} action - 'keypress', 'keydown', or 'keyup'
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
bind: function(keys, callback, action) {
|
|
||||||
keys = keys instanceof Array ? keys : [keys];
|
|
||||||
_bindMultiple(keys, callback, action);
|
|
||||||
return this;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* unbinds an event to mousetrap
|
|
||||||
*
|
|
||||||
* the unbinding sets the callback function of the specified key combo
|
|
||||||
* to an empty function and deletes the corresponding key in the
|
|
||||||
* _directMap dict.
|
|
||||||
*
|
|
||||||
* TODO: actually remove this from the _callbacks dictionary instead
|
|
||||||
* of binding an empty function
|
|
||||||
*
|
|
||||||
* the keycombo+action has to be exactly the same as
|
|
||||||
* it was defined in the bind method
|
|
||||||
*
|
|
||||||
* @param {string|Array} keys
|
|
||||||
* @param {string} action
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
unbind: function(keys, action) {
|
|
||||||
return Mousetrap.bind(keys, function() {}, action);
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* triggers an event that has already been bound
|
|
||||||
*
|
|
||||||
* @param {string} keys
|
|
||||||
* @param {string=} action
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
trigger: function(keys, action) {
|
|
||||||
if (_directMap[keys + ':' + action]) {
|
|
||||||
_directMap[keys + ':' + action]({}, keys);
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* resets the library back to its initial state. this is useful
|
|
||||||
* if you want to clear out the current keyboard shortcuts and bind
|
|
||||||
* new ones - for example if you switch to another page
|
|
||||||
*
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
reset: function() {
|
|
||||||
_callbacks = {};
|
|
||||||
_directMap = {};
|
|
||||||
return this;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* should we stop this event before firing off callbacks
|
|
||||||
*
|
|
||||||
* @param {Event} e
|
|
||||||
* @param {Element} element
|
|
||||||
* @return {boolean}
|
|
||||||
*/
|
|
||||||
stopCallback: function(e, element) {
|
|
||||||
|
|
||||||
// if the element has the class "mousetrap" then no need to stop
|
|
||||||
if ((' ' + element.className + ' ').indexOf(' mousetrap ') > -1) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// stop for input, select, and textarea
|
|
||||||
return element.tagName == 'INPUT' || element.tagName == 'SELECT' || element.tagName == 'TEXTAREA' || element.isContentEditable;
|
|
||||||
},
|
|
||||||
|
|
||||||
/**
|
|
||||||
* exposes _handleKey publicly so it can be overwritten by extensions
|
|
||||||
*/
|
|
||||||
handleKey: _handleKey
|
|
||||||
};
|
|
||||||
|
|
||||||
// expose mousetrap to the global object
|
|
||||||
window.Mousetrap = Mousetrap;
|
|
||||||
|
|
||||||
// expose mousetrap as an AMD module
|
|
||||||
if (typeof define === 'function' && define.amd) {
|
|
||||||
define(Mousetrap);
|
|
||||||
}
|
|
||||||
}) (window, document);
|
|
||||||
Vendored
-2068
File diff suppressed because it is too large
Load Diff
@@ -1,11 +1,16 @@
|
|||||||
.book {
|
.book {
|
||||||
|
position: relative;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
|
||||||
.book-body {
|
.book-body {
|
||||||
position: fixed;
|
position: absolute;
|
||||||
top: @header-height;
|
top: @header-height;
|
||||||
right: 0px;
|
right: 0px;
|
||||||
left: 0px;
|
left: 0px;
|
||||||
bottom: 0px;
|
bottom: 0px;
|
||||||
|
|
||||||
|
color: @page-color;
|
||||||
background: @body-background;
|
background: @body-background;
|
||||||
.transition(left 0.5s ease);
|
.transition(left 0.5s ease);
|
||||||
|
|
||||||
@@ -23,7 +28,6 @@
|
|||||||
outline: none;
|
outline: none;
|
||||||
|
|
||||||
.page-inner {
|
.page-inner {
|
||||||
font-family: @font-family-serif;
|
|
||||||
max-width: 800px;
|
max-width: 800px;
|
||||||
margin: 0px auto;
|
margin: 0px auto;
|
||||||
|
|
||||||
@@ -33,8 +37,6 @@
|
|||||||
|
|
||||||
background: @page-background;
|
background: @page-background;
|
||||||
border-radius: 2px;
|
border-radius: 2px;
|
||||||
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.5em;
|
line-height: 1.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,7 +62,7 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
&.with-summary {
|
&.with-summary {
|
||||||
@media (min-width: 800px) {
|
@media (min-width: @sidebar-breakpoint) {
|
||||||
.book-body {
|
.book-body {
|
||||||
left: 250px;
|
left: 250px;
|
||||||
}
|
}
|
||||||
@@ -72,4 +74,63 @@
|
|||||||
.transition(none) !important;
|
.transition(none) !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
&.color-theme-1{
|
||||||
|
.book-body {
|
||||||
|
color: @page-color-1;
|
||||||
|
background: @body-background-1;
|
||||||
|
.page-wrapper {
|
||||||
|
.page-inner {
|
||||||
|
section{
|
||||||
|
background: @page-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.color-theme-2{
|
||||||
|
.book-body {
|
||||||
|
color: @page-color-2;
|
||||||
|
background: @body-background-2;
|
||||||
|
.page-wrapper {
|
||||||
|
.page-inner {
|
||||||
|
section{
|
||||||
|
background: @page-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
&.font-size-0 {
|
||||||
|
.book-body {
|
||||||
|
font-size:@s-font-size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.font-size-1 {
|
||||||
|
.book-body {
|
||||||
|
font-size:@m-font-size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.font-size-2 {
|
||||||
|
.book-body {
|
||||||
|
font-size:@l-font-size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.font-size-3 {
|
||||||
|
.book-body {
|
||||||
|
font-size:@xl-font-size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.font-size-4 {
|
||||||
|
.book-body {
|
||||||
|
font-size:@xxl-font-size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
&.font-family-0{
|
||||||
|
font-family: @font-family-serif;
|
||||||
|
}
|
||||||
|
&.font-family-1{
|
||||||
|
font-family: @font-family-sans;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
.book .book-body .page-wrapper .page-inner {
|
.book .book-body .page-wrapper .page-inner {
|
||||||
section.exercise {
|
section.exercise {
|
||||||
padding: 0px;
|
padding: 0px;
|
||||||
margin: 20px 0px;
|
margin: 20px 15px;
|
||||||
border: 3px solid #2f8cde;
|
border: 3px solid #2f8cde;
|
||||||
|
|
||||||
.header {
|
.header {
|
||||||
|
|||||||
@@ -0,0 +1,159 @@
|
|||||||
|
.book-header{
|
||||||
|
#font-settings-wrapper{
|
||||||
|
position:relative;
|
||||||
|
.dropdown-menu{
|
||||||
|
background-color:@header-background;
|
||||||
|
border-color:@sidebar-divider-color;
|
||||||
|
padding: 0px;
|
||||||
|
|
||||||
|
.dropdown-caret{
|
||||||
|
position: absolute;
|
||||||
|
top: 14px;
|
||||||
|
left: -8px;
|
||||||
|
width: 10px;
|
||||||
|
height: 18px;
|
||||||
|
float: left;
|
||||||
|
overflow: hidden;
|
||||||
|
.caret-outer{
|
||||||
|
position: absolute;
|
||||||
|
border-bottom: 9px solid transparent;
|
||||||
|
border-top: 9px solid transparent;
|
||||||
|
border-right: 9px solid rgba(0,0,0,0.1);
|
||||||
|
height: auto;
|
||||||
|
left: 0;
|
||||||
|
top: 0;
|
||||||
|
width: auto;
|
||||||
|
display: inline-block;
|
||||||
|
margin-left: -1px;
|
||||||
|
}
|
||||||
|
.caret-inner{
|
||||||
|
position: absolute;
|
||||||
|
display: inline-block;
|
||||||
|
margin-left: -1px;
|
||||||
|
top: 0;
|
||||||
|
left: 1px;
|
||||||
|
border-bottom: 9px solid transparent;
|
||||||
|
border-top: 9px solid transparent;
|
||||||
|
border-right: 9px solid @header-background;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
button{
|
||||||
|
border: 0;
|
||||||
|
background-color:transparent;
|
||||||
|
color:@header-button-color;
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color;
|
||||||
|
background-color:@header-button-hover-background;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#enlarge-font-size{
|
||||||
|
width: 50%;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
#reduce-font-size{
|
||||||
|
width: 50.5%;
|
||||||
|
font-size:1em;
|
||||||
|
}
|
||||||
|
.btn-group-xs{
|
||||||
|
.btn{
|
||||||
|
width: 33.7%;
|
||||||
|
padding: initial;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.list-group{
|
||||||
|
margin: 0px 0;
|
||||||
|
|
||||||
|
.list-group-item{
|
||||||
|
cursor:pointer;
|
||||||
|
background-color:transparent;
|
||||||
|
border-color: @sidebar-divider-color;
|
||||||
|
border-width: 1px 0 !important;
|
||||||
|
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color;
|
||||||
|
background-color:@header-button-hover-background !important;
|
||||||
|
}
|
||||||
|
&.active{
|
||||||
|
color:@header-button-hover-color;
|
||||||
|
background-color:@header-button-hover-background !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.open{
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Theme 1
|
||||||
|
*/
|
||||||
|
|
||||||
|
.color-theme-1{
|
||||||
|
#font-settings-wrapper{
|
||||||
|
.dropdown-menu{
|
||||||
|
background-color:@sidebar-background-1;
|
||||||
|
border-color:@sidebar-divider-color-1;
|
||||||
|
.dropdown-caret .caret-inner{
|
||||||
|
border-right: 9px solid @sidebar-background-1;
|
||||||
|
}
|
||||||
|
button{
|
||||||
|
color:@header-button-color-1;
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color-1;
|
||||||
|
background-color:@header-button-hover-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.list-group{
|
||||||
|
.list-group-item{
|
||||||
|
border-color:@sidebar-divider-color-1;
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color-1;
|
||||||
|
background-color:@header-button-hover-background-1 !important;
|
||||||
|
}
|
||||||
|
&.active{
|
||||||
|
color:@header-button-hover-color-1;
|
||||||
|
background-color:@header-button-hover-background-1 !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Theme 2
|
||||||
|
*/
|
||||||
|
|
||||||
|
.color-theme-2{
|
||||||
|
#font-settings-wrapper{
|
||||||
|
.dropdown-menu{
|
||||||
|
background-color:@sidebar-background-2;
|
||||||
|
border-color:@sidebar-divider-color-2;
|
||||||
|
.dropdown-caret .caret-inner{
|
||||||
|
border-right: 9px solid @sidebar-background-2;
|
||||||
|
}
|
||||||
|
button{
|
||||||
|
color:@header-button-color-2;
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color-2;
|
||||||
|
background-color:@header-button-hover-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.list-group{
|
||||||
|
.list-group-item{
|
||||||
|
border-color:@sidebar-divider-color-2;
|
||||||
|
&:hover{
|
||||||
|
color:@header-button-hover-color-2;
|
||||||
|
background-color:@header-button-hover-background-2 !important;
|
||||||
|
}
|
||||||
|
&.active{
|
||||||
|
color:@header-button-hover-color-2;
|
||||||
|
background-color:@header-button-hover-background-2 !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,8 +2,8 @@
|
|||||||
.book-header {
|
.book-header {
|
||||||
font-family: @font-family-sans;
|
font-family: @font-family-sans;
|
||||||
|
|
||||||
position: fixed;
|
position: absolute;
|
||||||
overflow: hidden;
|
overflow: visible;
|
||||||
top: 0px;
|
top: 0px;
|
||||||
right: 0px;
|
right: 0px;
|
||||||
left: 0px;
|
left: 0px;
|
||||||
@@ -24,6 +24,7 @@
|
|||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
line-height: @header-height;
|
line-height: @header-height;
|
||||||
.box-shadow(none) !important;
|
.box-shadow(none) !important;
|
||||||
|
position:relative;
|
||||||
|
|
||||||
&:hover {
|
&:hover {
|
||||||
position: relative;
|
position: relative;
|
||||||
@@ -51,9 +52,23 @@
|
|||||||
@media (max-width: 800px) {
|
@media (max-width: 800px) {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
i {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
&.is-loading {
|
||||||
|
.book-header h1 {
|
||||||
|
i {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
a {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
&.with-summary {
|
&.with-summary {
|
||||||
.book-header h1 {
|
.book-header h1 {
|
||||||
margin-left: 250px;
|
margin-left: 250px;
|
||||||
@@ -64,4 +79,30 @@
|
|||||||
.transition(none) !important;
|
.transition(none) !important;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
&.color-theme-1{
|
||||||
|
.book-header{
|
||||||
|
color: @header-color-1;
|
||||||
|
background: @header-background-1;
|
||||||
|
.btn {
|
||||||
|
color: @header-button-color-1;
|
||||||
|
&:hover {
|
||||||
|
color: @header-button-hover-color-1;
|
||||||
|
background: @header-button-hover-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
&.color-theme-2{
|
||||||
|
.book-header{
|
||||||
|
color: @header-color-2;
|
||||||
|
background: @header-background-2;
|
||||||
|
.btn {
|
||||||
|
color: @header-button-color-2;
|
||||||
|
&:hover {
|
||||||
|
color: @header-button-hover-color-2;
|
||||||
|
background: @header-button-hover-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
/* Tomorrow Night Bright Theme */
|
||||||
|
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||||
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
|
||||||
|
/* Tomorrow Comment */
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-title {
|
||||||
|
color: #969896;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Red */
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-regexp,
|
||||||
|
.ruby .hljs-constant,
|
||||||
|
.xml .hljs-tag .hljs-title,
|
||||||
|
.xml .hljs-pi,
|
||||||
|
.xml .hljs-doctype,
|
||||||
|
.html .hljs-doctype,
|
||||||
|
.css .hljs-id,
|
||||||
|
.css .hljs-class,
|
||||||
|
.css .hljs-pseudo {
|
||||||
|
color: #d54e53;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Orange */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-preprocessor,
|
||||||
|
.hljs-pragma,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-params,
|
||||||
|
.hljs-constant {
|
||||||
|
color: #e78c45;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Yellow */
|
||||||
|
.ruby .hljs-class .hljs-title,
|
||||||
|
.css .hljs-rules .hljs-attribute {
|
||||||
|
color: #e7c547;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Green */
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-value,
|
||||||
|
.hljs-inheritance,
|
||||||
|
.hljs-header,
|
||||||
|
.ruby .hljs-symbol,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
color: #b9ca4a;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Aqua */
|
||||||
|
.css .hljs-hexcolor {
|
||||||
|
color: #70c0b1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Blue */
|
||||||
|
.hljs-function,
|
||||||
|
.python .hljs-decorator,
|
||||||
|
.python .hljs-title,
|
||||||
|
.ruby .hljs-function .hljs-title,
|
||||||
|
.ruby .hljs-title .hljs-keyword,
|
||||||
|
.perl .hljs-sub,
|
||||||
|
.javascript .hljs-title,
|
||||||
|
.coffeescript .hljs-title {
|
||||||
|
color: #7aa6da;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Tomorrow Purple */
|
||||||
|
.hljs-keyword,
|
||||||
|
.javascript .hljs-function {
|
||||||
|
color: #c397d8;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
background: black;
|
||||||
|
color: #eaeaea;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.coffeescript .javascript,
|
||||||
|
.javascript .xml,
|
||||||
|
.tex .hljs-formula,
|
||||||
|
.xml .javascript,
|
||||||
|
.xml .vbscript,
|
||||||
|
.xml .css,
|
||||||
|
.xml .hljs-cdata {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
/*
|
||||||
|
|
||||||
|
Orginal Style from ethanschoonover.com/solarized (c) Jeremy Hull <sourdrums@gmail.com>
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
padding: 0.5em;
|
||||||
|
background: #fdf6e3;
|
||||||
|
color: #657b83;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-template_comment,
|
||||||
|
.diff .hljs-header,
|
||||||
|
.hljs-doctype,
|
||||||
|
.hljs-pi,
|
||||||
|
.lisp .hljs-string,
|
||||||
|
.hljs-javadoc {
|
||||||
|
color: #93a1a1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Green */
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-winutils,
|
||||||
|
.method,
|
||||||
|
.hljs-addition,
|
||||||
|
.css .hljs-tag,
|
||||||
|
.hljs-request,
|
||||||
|
.hljs-status,
|
||||||
|
.nginx .hljs-title {
|
||||||
|
color: #859900;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Cyan */
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-command,
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-tag .hljs-value,
|
||||||
|
.hljs-rules .hljs-value,
|
||||||
|
.hljs-phpdoc,
|
||||||
|
.tex .hljs-formula,
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-hexcolor,
|
||||||
|
.hljs-link_url {
|
||||||
|
color: #2aa198;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Blue */
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-localvars,
|
||||||
|
.hljs-chunk,
|
||||||
|
.hljs-decorator,
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-identifier,
|
||||||
|
.vhdl .hljs-literal,
|
||||||
|
.hljs-id,
|
||||||
|
.css .hljs-function {
|
||||||
|
color: #268bd2;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Yellow */
|
||||||
|
.hljs-attribute,
|
||||||
|
.hljs-variable,
|
||||||
|
.lisp .hljs-body,
|
||||||
|
.smalltalk .hljs-number,
|
||||||
|
.hljs-constant,
|
||||||
|
.hljs-class .hljs-title,
|
||||||
|
.hljs-parent,
|
||||||
|
.haskell .hljs-type,
|
||||||
|
.hljs-link_reference {
|
||||||
|
color: #b58900;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Orange */
|
||||||
|
.hljs-preprocessor,
|
||||||
|
.hljs-preprocessor .hljs-keyword,
|
||||||
|
.hljs-pragma,
|
||||||
|
.hljs-shebang,
|
||||||
|
.hljs-symbol,
|
||||||
|
.hljs-symbol .hljs-string,
|
||||||
|
.diff .hljs-change,
|
||||||
|
.hljs-special,
|
||||||
|
.hljs-attr_selector,
|
||||||
|
.hljs-subst,
|
||||||
|
.hljs-cdata,
|
||||||
|
.clojure .hljs-title,
|
||||||
|
.css .hljs-pseudo,
|
||||||
|
.hljs-header {
|
||||||
|
color: #cb4b16;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Red */
|
||||||
|
.hljs-deletion,
|
||||||
|
.hljs-important {
|
||||||
|
color: #dc322f;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Solarized Violet */
|
||||||
|
.hljs-link_label {
|
||||||
|
color: #6c71c4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tex .hljs-formula {
|
||||||
|
background: #eee8d5;
|
||||||
|
}
|
||||||
+10
-10
@@ -1,8 +1,9 @@
|
|||||||
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
||||||
|
|
||||||
/* Tomorrow Comment */
|
/* Tomorrow Comment */
|
||||||
.hljs-comment {
|
.hljs-comment,
|
||||||
color: hsl(207, 35%, 35%);
|
.hljs-title {
|
||||||
|
color: #8e908c;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Tomorrow Red */
|
/* Tomorrow Red */
|
||||||
@@ -27,9 +28,9 @@
|
|||||||
.hljs-pragma,
|
.hljs-pragma,
|
||||||
.hljs-built_in,
|
.hljs-built_in,
|
||||||
.hljs-literal,
|
.hljs-literal,
|
||||||
.hljs-constant,
|
.hljs-params,
|
||||||
.hljs-function .hljs-title {
|
.hljs-constant {
|
||||||
color: hsl(50, 100%, 60%);
|
color: #f5871f;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Tomorrow Yellow */
|
/* Tomorrow Yellow */
|
||||||
@@ -45,7 +46,7 @@
|
|||||||
.hljs-header,
|
.hljs-header,
|
||||||
.ruby .hljs-symbol,
|
.ruby .hljs-symbol,
|
||||||
.xml .hljs-cdata {
|
.xml .hljs-cdata {
|
||||||
color: hsl(0, 100%, 70%);
|
color: #718c00;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Tomorrow Aqua */
|
/* Tomorrow Aqua */
|
||||||
@@ -54,7 +55,7 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* Tomorrow Blue */
|
/* Tomorrow Blue */
|
||||||
.hljs-function .keyword,
|
.hljs-function,
|
||||||
.python .hljs-decorator,
|
.python .hljs-decorator,
|
||||||
.python .hljs-title,
|
.python .hljs-title,
|
||||||
.ruby .hljs-function .hljs-title,
|
.ruby .hljs-function .hljs-title,
|
||||||
@@ -62,13 +63,13 @@
|
|||||||
.perl .hljs-sub,
|
.perl .hljs-sub,
|
||||||
.javascript .hljs-title,
|
.javascript .hljs-title,
|
||||||
.coffeescript .hljs-title {
|
.coffeescript .hljs-title {
|
||||||
color: hsl(207, 70%, 60%);
|
color: #4271ae;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Tomorrow Purple */
|
/* Tomorrow Purple */
|
||||||
.hljs-keyword,
|
.hljs-keyword,
|
||||||
.javascript .hljs-function {
|
.javascript .hljs-function {
|
||||||
color: hsl(207, 95%, 70%);
|
color: #8959a8;
|
||||||
}
|
}
|
||||||
|
|
||||||
.hljs {
|
.hljs {
|
||||||
@@ -76,7 +77,6 @@
|
|||||||
background: white;
|
background: white;
|
||||||
color: #4d4d4c;
|
color: #4d4d4c;
|
||||||
padding: 0.5em;
|
padding: 0.5em;
|
||||||
font-family: "Anonymous Pro", "Inconsolata", "Monaco", monospace;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.coffeescript .javascript,
|
.coffeescript .javascript,
|
||||||
@@ -1,8 +1,30 @@
|
|||||||
.book .book-body .page-wrapper .page-inner section.normal {
|
.book.color-theme-1 .book-body .page-wrapper .page-inner section.normal {
|
||||||
padding: 25px;
|
color:@page-color-1;
|
||||||
padding-top: 15px;
|
|
||||||
background-color: white;
|
|
||||||
|
|
||||||
|
pre, code {
|
||||||
|
background: #fdf6e3;
|
||||||
|
color: #657b83;
|
||||||
|
border-color: darken(#fdf6e3, 15%);
|
||||||
|
|
||||||
|
@import "./highlight/sepia.less";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.book.color-theme-2 .book-body .page-wrapper .page-inner section.normal {
|
||||||
|
color:@page-color-2;
|
||||||
|
|
||||||
|
pre, code {
|
||||||
|
background: black;
|
||||||
|
color: #eaeaea;
|
||||||
|
border-color: #000;
|
||||||
|
|
||||||
|
@import "./highlight/night.less";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.book .book-body .page-wrapper .page-inner section.normal {
|
||||||
|
padding-bottom: 25px;
|
||||||
|
padding-top: 15px;
|
||||||
|
color:@page-color;
|
||||||
|
letter-spacing: 0.01rem;
|
||||||
|
|
||||||
& > *:first-child {
|
& > *:first-child {
|
||||||
margin-top: 0 !important; }
|
margin-top: 0 !important; }
|
||||||
@@ -51,26 +73,25 @@
|
|||||||
font-size: inherit; }
|
font-size: inherit; }
|
||||||
|
|
||||||
h1 {
|
h1 {
|
||||||
font-size: 28px;
|
font-size: 2.5em;
|
||||||
color: black; }
|
}
|
||||||
|
|
||||||
h2 {
|
h2 {
|
||||||
font-size: 24px;
|
font-size: 2em;
|
||||||
border-bottom: 1px solid #eee;
|
border-bottom: 1px solid #eee;
|
||||||
color: black; }
|
}
|
||||||
|
|
||||||
h3 {
|
h3 {
|
||||||
font-size: 18px; }
|
font-size: 1.5em; }
|
||||||
|
|
||||||
h4 {
|
h4 {
|
||||||
font-size: 16px; }
|
font-size: 1.2em; }
|
||||||
|
|
||||||
h5 {
|
h5 {
|
||||||
font-size: 14px; }
|
font-size: 1em; }
|
||||||
|
|
||||||
h6 {
|
h6 {
|
||||||
color: #777777;
|
font-size: 1em; }
|
||||||
font-size: 14px; }
|
|
||||||
|
|
||||||
p, blockquote, ul, ol, dl, table, pre {
|
p, blockquote, ul, ol, dl, table, pre {
|
||||||
margin: 15px 0; }
|
margin: 15px 0; }
|
||||||
@@ -272,29 +293,15 @@
|
|||||||
white-space: pre;
|
white-space: pre;
|
||||||
border: none;
|
border: none;
|
||||||
background: transparent;
|
background: transparent;
|
||||||
}
|
|
||||||
|
|
||||||
.highlight pre {
|
@import "./highlight/white.less";
|
||||||
color: hsl(204, 40%, 80%);
|
|
||||||
background-color: hsl(204, 30%, 10%);
|
|
||||||
border: 1px solid hsl(204, 30%, 10%);
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.5em;
|
|
||||||
overflow: auto;
|
|
||||||
padding: 20px;
|
|
||||||
margin: 0 -20px;
|
|
||||||
border-radius: 3px;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pre {
|
pre {
|
||||||
color: hsl(204, 40%, 80%);
|
font-size: inherit;
|
||||||
background-color: hsl(204, 30%, 10%);
|
|
||||||
border: 1px solid hsl(204, 30%, 10%);
|
|
||||||
font-size: 16px;
|
|
||||||
line-height: 1.5em;
|
line-height: 1.5em;
|
||||||
overflow: auto;
|
overflow: auto;
|
||||||
padding: 20px;
|
padding: 20px;
|
||||||
margin: 0 -20px;
|
|
||||||
border-radius: 3px;
|
border-radius: 3px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -13,15 +13,15 @@
|
|||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
|
|
||||||
font-size: 40px;
|
font-size: 40px;
|
||||||
color: rgba(0,0,0,0.5);
|
color: rgba(0,0,0,0.4);
|
||||||
|
|
||||||
text-align: center;
|
text-align: center;
|
||||||
|
|
||||||
.transition(all 350ms ease);
|
.transition(all 350ms ease);
|
||||||
|
|
||||||
&:hover {
|
&:hover {
|
||||||
background-color: @body-pagination-background;
|
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
|
color: rgba(0,0,0,0.6);
|
||||||
}
|
}
|
||||||
|
|
||||||
&.navigation-next {
|
&.navigation-next {
|
||||||
@@ -40,6 +40,19 @@
|
|||||||
width: 50%;
|
width: 50%;
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
float: left;
|
float: left;
|
||||||
|
|
||||||
|
&.navigation-unique {
|
||||||
|
max-width: 100%;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
.book.color-theme-1 .book-body {
|
||||||
|
.navigation:hover{
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.book.color-theme-2 .book-body {
|
||||||
|
.navigation:hover{
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -16,8 +16,7 @@
|
|||||||
width: 100%;
|
width: 100%;
|
||||||
position: relative;
|
position: relative;
|
||||||
background: #fff;
|
background: #fff;
|
||||||
margin-bottom: 20px;
|
margin-bottom: 10px;
|
||||||
z-index: 10;
|
|
||||||
|
|
||||||
.bar {
|
.bar {
|
||||||
height: @bar-height;
|
height: @bar-height;
|
||||||
@@ -81,4 +80,36 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
.book.color-theme-1 .book-body {
|
||||||
|
.book-progress {
|
||||||
|
.bar {
|
||||||
|
background: @bar-background-1;
|
||||||
|
.inner {
|
||||||
|
background: @bar-progress-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.chapters .chapter{
|
||||||
|
background: @bar-background-1;
|
||||||
|
&.done{
|
||||||
|
background: @bar-progress-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.book.color-theme-2 .book-body {
|
||||||
|
.book-progress {
|
||||||
|
.bar {
|
||||||
|
background: @bar-background-2;
|
||||||
|
.inner {
|
||||||
|
background: @bar-progress-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.chapters .chapter{
|
||||||
|
background: @bar-background-2;
|
||||||
|
&.done{
|
||||||
|
background: @bar-progress-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
.book .book-body .page-wrapper .page-inner {
|
.book .book-body .page-wrapper .page-inner {
|
||||||
section.quiz {
|
section.quiz {
|
||||||
padding: 0px;
|
padding: 0px;
|
||||||
margin: 20px 0px;
|
margin: 20px 15px;
|
||||||
border: 3px solid #2f8cde;
|
border: 3px solid #2f8cde;
|
||||||
|
|
||||||
.header {
|
.header {
|
||||||
@@ -29,8 +29,12 @@
|
|||||||
|
|
||||||
.question-inner {
|
.question-inner {
|
||||||
padding: 15px;
|
padding: 15px;
|
||||||
|
.quiz-label {
|
||||||
|
font-weight: normal;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
table {
|
table {
|
||||||
margin-bottom: 10px;
|
margin-bottom: 10px;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
@@ -46,4 +50,4 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
.book-summary {
|
.book-summary {
|
||||||
font-family: @font-family-sans;
|
font-family: @font-family-sans;
|
||||||
|
|
||||||
position: fixed;
|
position: absolute;
|
||||||
top: @header-height;
|
top: @header-height;
|
||||||
left: -@sidebar-width;
|
left: -@sidebar-width;
|
||||||
bottom: 0px;
|
bottom: 0px;
|
||||||
@@ -90,7 +90,6 @@
|
|||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
position: relative;
|
position: relative;
|
||||||
padding-left: 25px;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
span {
|
span {
|
||||||
@@ -110,7 +109,7 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (max-width: 600px) {
|
@media (max-width: @sidebar-breakpoint) {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
bottom: 0px;
|
bottom: 0px;
|
||||||
left: -100%;
|
left: -100%;
|
||||||
@@ -141,3 +140,93 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Theme 1
|
||||||
|
*/
|
||||||
|
.book.color-theme-1 {
|
||||||
|
.book-summary {
|
||||||
|
color: @sidebar-color-1;
|
||||||
|
background: @sidebar-background-1;
|
||||||
|
|
||||||
|
.book-search {
|
||||||
|
background: @sidebar-search-background-1;
|
||||||
|
|
||||||
|
input, input:focus {
|
||||||
|
border: 1px solid @sidebar-search-input-border-color-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.summary {
|
||||||
|
li {
|
||||||
|
&.divider {
|
||||||
|
background: @sidebar-divider-color-1;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
i.fa-check {
|
||||||
|
color: @sidebar-icon-color-1;
|
||||||
|
}
|
||||||
|
|
||||||
|
&.done > a {
|
||||||
|
color: @sidebar-link-completed-1;
|
||||||
|
}
|
||||||
|
|
||||||
|
a, span {
|
||||||
|
color: @sidebar-link-color-1;
|
||||||
|
background: @sidebar-link-background-1;
|
||||||
|
}
|
||||||
|
|
||||||
|
&.active > a, a:hover {
|
||||||
|
color: @sidebar-link-hover-color-1;
|
||||||
|
background: @sidebar-link-hover-background-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Theme 2
|
||||||
|
*/
|
||||||
|
.book.color-theme-2{
|
||||||
|
.book-summary {
|
||||||
|
color: @sidebar-color-2;
|
||||||
|
background: @sidebar-background-2;
|
||||||
|
|
||||||
|
.book-search {
|
||||||
|
background: @sidebar-search-background-2;
|
||||||
|
|
||||||
|
input, input:focus {
|
||||||
|
border: 1px solid @sidebar-search-input-border-color-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.summary {
|
||||||
|
li {
|
||||||
|
&.divider {
|
||||||
|
background: @sidebar-divider-color-2;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
i.fa-check {
|
||||||
|
color: @sidebar-icon-color-2;
|
||||||
|
}
|
||||||
|
|
||||||
|
&.done > a {
|
||||||
|
color: @sidebar-link-completed-2;
|
||||||
|
}
|
||||||
|
|
||||||
|
a, span {
|
||||||
|
color: @sidebar-link-color-2;
|
||||||
|
background: @sidebar-link-background-2;
|
||||||
|
}
|
||||||
|
|
||||||
|
&.active > a, a:hover {
|
||||||
|
color: @sidebar-link-hover-color-2;
|
||||||
|
background: @sidebar-link-hover-background-2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -5,10 +5,10 @@
|
|||||||
@import "variables.less";
|
@import "variables.less";
|
||||||
@import "fonts.less";
|
@import "fonts.less";
|
||||||
|
|
||||||
@import "book/highlight.less";
|
|
||||||
@import "book/languages.less";
|
@import "book/languages.less";
|
||||||
@import "book/header.less";
|
@import "book/header.less";
|
||||||
@import "book/summary.less";
|
@import "book/summary.less";
|
||||||
|
@import "book/font-settings.less";
|
||||||
@import "book/body.less";
|
@import "book/body.less";
|
||||||
@import "book/exercise.less";
|
@import "book/exercise.less";
|
||||||
@import "book/quiz.less";
|
@import "book/quiz.less";
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
|
/* http://jmblog.github.io/color-themes-for-highlightjs */
|
||||||
|
|
||||||
/* Tomorrow Comment */
|
/* Tomorrow Comment */
|
||||||
.hljs-comment,
|
.hljs-comment,
|
||||||
@@ -87,4 +87,4 @@
|
|||||||
.xml .css,
|
.xml .css,
|
||||||
.xml .hljs-cdata {
|
.xml .hljs-cdata {
|
||||||
opacity: 0.5;
|
opacity: 0.5;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,14 +13,14 @@
|
|||||||
|
|
||||||
// Body
|
// Body
|
||||||
@body-background: white;
|
@body-background: white;
|
||||||
@body-pagination-background: hsl(207, 15%, 95%);
|
|
||||||
|
|
||||||
// Sidebar
|
// Sidebar
|
||||||
@sidebar-width: 250px;
|
@sidebar-width: 250px;
|
||||||
|
@sidebar-breakpoint: 600px;
|
||||||
@sidebar-color: hsl(207, 15%, 80%);
|
@sidebar-color: hsl(207, 15%, 80%);
|
||||||
@sidebar-background: hsl(207, 15%, 95%);
|
@sidebar-background: hsl(207, 15%, 95%);
|
||||||
|
|
||||||
@sidebar-nested-padding: 10px;
|
@sidebar-nested-padding: 20px;
|
||||||
|
|
||||||
@sidebar-search-padding: 6px;
|
@sidebar-search-padding: 6px;
|
||||||
@sidebar-search-background: transparent;
|
@sidebar-search-background: transparent;
|
||||||
@@ -38,6 +38,7 @@
|
|||||||
@sidebar-link-completed-weight: normal;
|
@sidebar-link-completed-weight: normal;
|
||||||
|
|
||||||
// Page
|
// Page
|
||||||
|
@page-color: black;
|
||||||
@page-background: white;
|
@page-background: white;
|
||||||
|
|
||||||
// Progress Bar
|
// Progress Bar
|
||||||
@@ -79,5 +80,92 @@
|
|||||||
@font-family-sans: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
|
@font-family-sans: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||||
@font-family-base: @font-family-serif;
|
@font-family-base: @font-family-serif;
|
||||||
|
|
||||||
|
|
||||||
@FontPath: '@{staticPath}/fonts';
|
@FontPath: '@{staticPath}/fonts';
|
||||||
@fa-font-path: "@{FontPath}/fontawesome";
|
@fa-font-path: "@{FontPath}/fontawesome";
|
||||||
|
|
||||||
|
@s-font-size: 1.2rem;
|
||||||
|
@m-font-size: 1.4rem;
|
||||||
|
@l-font-size: 1.6rem;
|
||||||
|
@xl-font-size: 2.2rem;
|
||||||
|
@xxl-font-size: 4.0rem;
|
||||||
|
|
||||||
|
/*
|
||||||
|
,--------.,--.
|
||||||
|
'--. .--'| ,---. ,---. ,--,--,--. ,---. ,---. .--.
|
||||||
|
| | | .-. || .-. :| || .-. :( .-' '--'
|
||||||
|
| | | | | |\ --.| | | |\ --..-' `).--.
|
||||||
|
`--' `--' `--' `----'`--`--`--' `----'`----' '--'
|
||||||
|
*/
|
||||||
|
// Header
|
||||||
|
@header-color-1: #AFA790;
|
||||||
|
@header-color-2: #7e888b;
|
||||||
|
@header-background-1: #ECE3C4;
|
||||||
|
@header-background-2: #1d1f21;
|
||||||
|
@header-button-color-1: #AFA790;
|
||||||
|
@header-button-color-2: #7e888b;
|
||||||
|
@header-button-hover-color-1: #73553C;
|
||||||
|
@header-button-hover-color-2: #C9C9C9;
|
||||||
|
@header-button-hover-background-1: #E2DABE;
|
||||||
|
@header-button-hover-background-2: #0B0D0E;
|
||||||
|
|
||||||
|
// Body
|
||||||
|
@body-background-1: #F3EACB;
|
||||||
|
@body-background-2: #1d1f21;
|
||||||
|
|
||||||
|
// Sidebar
|
||||||
|
@sidebar-color-1: #AFA790;
|
||||||
|
@sidebar-color-2: hsl(207, 15%, 80%);
|
||||||
|
@sidebar-background-1: #F3EACB;
|
||||||
|
@sidebar-background-2: #111111;
|
||||||
|
|
||||||
|
@sidebar-search-background-1: transparent;
|
||||||
|
@sidebar-search-background-2: transparent;
|
||||||
|
@sidebar-search-input-border-color-1: #D6CFBA;
|
||||||
|
@sidebar-search-input-border-color-2: #c4cdd4;
|
||||||
|
|
||||||
|
@sidebar-divider-color-1: hsl(207, 15%, 85%);
|
||||||
|
@sidebar-divider-color-2: #1d1f21;
|
||||||
|
|
||||||
|
@sidebar-link-color-1: #877F6A;
|
||||||
|
@sidebar-link-color-2: hsl(207, 15%, 50%);
|
||||||
|
@sidebar-link-background-1: transparent;
|
||||||
|
@sidebar-link-background-2: transparent;
|
||||||
|
@sidebar-link-hover-color-1: #704214;
|
||||||
|
@sidebar-link-hover-color-2: hsl(207, 100%, 50%);
|
||||||
|
@sidebar-link-hover-background-1: transparent;
|
||||||
|
@sidebar-link-hover-background-2: transparent;
|
||||||
|
|
||||||
|
@sidebar-icon-color-1: @bar-progress-background;
|
||||||
|
@sidebar-icon-color-2: @bar-progress-background;
|
||||||
|
@sidebar-link-completed-1: hsl(207, 15%, 25%);
|
||||||
|
@sidebar-link-completed-2: hsl(207, 15%, 25%);
|
||||||
|
@sidebar-link-completed-weight-1: normal;
|
||||||
|
@sidebar-link-completed-weight-2: normal;
|
||||||
|
|
||||||
|
// Page
|
||||||
|
@page-color-1: #704214;
|
||||||
|
@page-color-2: #a4b1b1;
|
||||||
|
@page-background-1: #F3EACB;
|
||||||
|
@page-background-2: #1d1f21;
|
||||||
|
|
||||||
|
@bar-background-1: #F3EACB;
|
||||||
|
@bar-background-2: #1d1f21;
|
||||||
|
@bar-progress-background-1: #704214;
|
||||||
|
@bar-progress-background-2: hsl(120, 60%, 50%);
|
||||||
|
|
||||||
|
// Basics of a navbar
|
||||||
|
@navbar-default-border-1: #d5d5d5;
|
||||||
|
@navbar-default-border-2: #d5d5d5;
|
||||||
|
|
||||||
|
// Navbar brand label
|
||||||
|
@navbar-default-color-1: #333;
|
||||||
|
@navbar-default-color-2: #333;
|
||||||
|
@navbar-default-link-color-1: #333;
|
||||||
|
@navbar-default-link-color-2: #333;
|
||||||
|
@navbar-default-brand-color-1: @navbar-default-link-color;
|
||||||
|
@navbar-default-brand-color-2: @navbar-default-link-color;
|
||||||
|
@navbar-default-brand-hover-color-1: @navbar-default-link-color;
|
||||||
|
@navbar-default-brand-hover-color-2: @navbar-default-link-color;
|
||||||
|
@navbar-default-brand-hover-bg-1: transparent;
|
||||||
|
@navbar-default-brand-hover-bg-2: transparent;
|
||||||
|
|||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<div class="dropdown-menu font-settings">
|
||||||
|
<div class="dropdown-caret">
|
||||||
|
<span class="caret-outer"></span>
|
||||||
|
<span class="caret-inner"></span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="btn-group btn-block">
|
||||||
|
<button id="reduce-font-size" class="btn btn-default">A</button>
|
||||||
|
<button id="enlarge-font-size" class="btn btn-default">A</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<ul class="list-group font-family-list">
|
||||||
|
<li class="list-group-item" data-font="0">Serif</li>
|
||||||
|
<li class="list-group-item" data-font="1">Sans</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div class="btn-group btn-group-xs btn-block color-theme-list">
|
||||||
|
<button type="button" class="btn btn-default" id="color-theme-preview-0" data-theme="0">White</button>
|
||||||
|
<button type="button" class="btn btn-default" id="color-theme-preview-1" data-theme="1">Sepia</button>
|
||||||
|
<button type="button" class="btn btn-default" id="color-theme-preview-2" data-theme="2">Night</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
@@ -1,21 +1,35 @@
|
|||||||
<div class="book-header">
|
<div class="book-header">
|
||||||
<!-- Actions Left -->
|
<!-- Actions Left -->
|
||||||
{% if githubId %}
|
<a href="#" class="btn pull-left toggle-summary" aria-label="Toggle summary"><i class="fa fa-align-justify"></i></a>
|
||||||
<a href="{{ githubHost }}{{ githubId }}" target="_blank" class="btn pull-left"><i class="fa fa-github-alt"></i></a>
|
{% if options.links.home !== false and (options.links.home != null or githubId) %}
|
||||||
|
<a href="{{ options.links.home|default(githubHost+githubId) }}" target="_blank" class="btn pull-left home-bookmark" aria-label="GitHub home"><i class="fa fa-bookmark-o"></i></a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<a href="#" class="btn pull-left toggle-summary"><i class="fa fa-align-justify"></i></a>
|
<a href="#" class="btn pull-left toggle-search" aria-label="Toggle search"><i class="fa fa-search"></i></a>
|
||||||
<a href="#" class="btn pull-left toggle-search"><i class="fa fa-search"></i></a>
|
<span id="font-settings-wrapper">
|
||||||
|
<a href="#" class="btn pull-left toggle-font-settings" aria-label="Toggle font settings"><i class="fa fa-font"></i>
|
||||||
|
</a>
|
||||||
|
{% include "./font-settings.html" %}
|
||||||
|
</span>
|
||||||
|
|
||||||
<!-- Actions Right -->
|
<!-- Actions Right -->
|
||||||
<a href="#" target="_blank" class="btn pull-right" data-sharing="google-plus"><i class="fa fa-google-plus"></i></a>
|
{% if options.links.sharing.google !== false %}
|
||||||
<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 google-plus-sharing-link sharing-link" data-sharing="google-plus" aria-label="Share on Google Plus"><i class="fa fa-google-plus"></i></a>
|
||||||
<a href="#" target="_blank" class="btn pull-right" data-sharing="twitter"><i class="fa fa-twitter"></i></a>
|
{% endif %}
|
||||||
|
{% if options.links.sharing.facebook !== false %}
|
||||||
|
<a href="#" target="_blank" class="btn pull-right facebook-sharing-link sharing-link" data-sharing="facebook" aria-label="Share on Facebook"><i class="fa fa-facebook"></i></a>
|
||||||
|
{% endif %}
|
||||||
|
{% if options.links.sharing.twitter !== false %}
|
||||||
|
<a href="#" target="_blank" class="btn pull-right twitter-sharing-link sharing-link" data-sharing="twitter" aria-label="Share on Twitter"><i class="fa fa-twitter"></i></a>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% if githubId %}
|
{% if githubId %}
|
||||||
<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 }}/stargazers" target="_blank" class="btn pull-right count-star hidden-xs"><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>
|
<a href="{{ githubHost }}{{ githubId }}/watchers" target="_blank" class="btn pull-right count-watch hidden-xs"><i class="fa fa-eye"></i> Watch (<span>-</span>)</a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<!-- Title -->
|
<!-- Title -->
|
||||||
<h1><a href="{{ basePath }}/" >{{ title }}</a></h1>
|
<h1>
|
||||||
|
<i class="fa fa-spinner fa-spin"></i>
|
||||||
|
<a href="{{ basePath }}/" >{{ title }}</a>
|
||||||
|
</h1>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,48 +1,63 @@
|
|||||||
|
{% macro articles(_articles) %}
|
||||||
|
{% for item in _articles %}
|
||||||
|
<li class="chapter {% if item._path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path %}data-path="{{ item.path|mdLink }}"{% endif %}>
|
||||||
|
{% if item.path %}
|
||||||
|
<a href="{{ basePath }}/{{ item.path|mdLink }}">
|
||||||
|
<i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
|
||||||
|
</a>
|
||||||
|
{% else %}
|
||||||
|
<span><b>{{ item.level }}.</b> {{ item.title }}</span>
|
||||||
|
{% endif %}
|
||||||
|
{% if item.articles.length > 0 %}
|
||||||
|
<ul class="articles">
|
||||||
|
{{ articles(item.articles) }}
|
||||||
|
</ul>
|
||||||
|
{% endif %}
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
{% endmacro %}
|
||||||
|
|
||||||
<div class="book-summary">
|
<div class="book-summary">
|
||||||
<div class="book-search">
|
<div class="book-search">
|
||||||
<input type="text" placeholder="Search" class="form-control" />
|
<input type="text" placeholder="Search" class="form-control" />
|
||||||
</div>
|
</div>
|
||||||
<ul class="summary">
|
<ul class="summary">
|
||||||
{% if githubId %}
|
{% set _divider = false %}
|
||||||
|
{% if options.links.about !== false && (options.links.about || githubId) %}
|
||||||
|
{% set _divider = true %}
|
||||||
<li>
|
<li>
|
||||||
<a href="{{ githubHost }}{{ githubAuthor }}" target="blank">About the author</a>
|
<a href="{{ options.links.about|default(githubHost+githubAuthor) }}" target="blank" class="author-link">About the author</a>
|
||||||
</li>
|
</li>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if options.links.issues !== false && (options.links.issues || githubId) %}
|
||||||
|
{% set _divider = true %}
|
||||||
<li>
|
<li>
|
||||||
<a href="{{ githubHost }}{{ githubId }}/issues" target="blank">Questions and Issues</a>
|
<a href="{{ options.links.issues|default(githubHost+githubId+"/issues") }}" target="blank"class="issues-link">Questions and Issues</a>
|
||||||
</li>
|
</li>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if options.links.contribute !== false && (options.links.contribute || githubId) %}
|
||||||
|
{% set _divider = true %}
|
||||||
<li>
|
<li>
|
||||||
<a href="{{ githubHost }}{{ githubId }}/edit/master/{{ _input }}" target="blank">Edit and Contribute</a>
|
<a href="{{ options.links.contribute|default(githubHost+githubId+"/edit/master/"+_input) }}" target="blank" class="contribute-link">Edit and Contribute</a>
|
||||||
</li>
|
</li>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if _divider %}
|
||||||
<li class="divider"></li>
|
<li class="divider"></li>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<li data-level="0" data-path="index.html">
|
<li data-level="0" data-path="index.html">
|
||||||
<a href="{{ basePath }}/"><i class="fa fa-check"></i> Introduction</a>
|
<a href="{{ basePath }}/"><i class="fa fa-check"></i> Introduction</a>
|
||||||
</li>
|
</li>
|
||||||
{% for item in summary.chapters %}
|
{{ articles(summary.chapters) }}
|
||||||
<li {% if item._path == _input %}class="active"{% endif %} data-level="{{ item.level }}" {% if item.path %}data-path="{{ item.path|mdLink }}"{% endif %}>
|
|
||||||
{% if item.path %}
|
{% if options.links.gitbook !== false %}
|
||||||
<a href="{{ basePath }}/{{ item.path|mdLink }}">
|
<li class="divider"></li>
|
||||||
<i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
|
<li>
|
||||||
</a>
|
<a href="http://www.gitbook.io/" target="blank" class="gitbook-link">Generated using GitBook</a>
|
||||||
{% else %}
|
</li>
|
||||||
<span><b>{{ item.level }}.</b> {{ item.title }}</span>
|
{% endif %}
|
||||||
{% endif %}
|
|
||||||
{% if item.articles.length > 0 %}
|
|
||||||
<ul class="articles">
|
|
||||||
{% for article in item.articles %}
|
|
||||||
<li {% if article._path == _input %}class="active"{% endif %} data-level="{{ article.level }}" {% if article.path %}data-path="{{ article.path|mdLink }}"{% endif %}>
|
|
||||||
{% if article.path %}
|
|
||||||
<a href="{{ basePath }}/{{ article.path|mdLink }}">
|
|
||||||
<i class="fa fa-check"></i> <b>{{ article.level }}.</b> {{ article.title }}
|
|
||||||
</a>
|
|
||||||
{% else %}
|
|
||||||
<span><b>{{ article.level }}.</b> {{ article.title }}</span>
|
|
||||||
{% endif %}
|
|
||||||
</li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% endif %}
|
|
||||||
</li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
<!DOCTYPE HTML>
|
<!DOCTYPE HTML>
|
||||||
<html lang="en-US">
|
<html lang="en-US" {% block htmlTag %}{% endblock %}>
|
||||||
|
{{ htmlSnippet("html:start")|default("") }}
|
||||||
<head prefix="og: http://ogp.me/ns# book: http://ogp.me/ns/book#">
|
<head prefix="og: http://ogp.me/ns# book: http://ogp.me/ns/book#">
|
||||||
|
{{ htmlSnippet("head:start")|default("") }}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<title>{% block title %} | {{ title }}{% endblock %}</title>
|
<title>{% block title %} | {{ title }}{% endblock %}</title>
|
||||||
@@ -33,20 +35,21 @@
|
|||||||
|
|
||||||
<link rel="shortcut icon" href="{{ staticBase }}/images/favicon.ico" type="image/x-icon">
|
<link rel="shortcut icon" href="{{ staticBase }}/images/favicon.ico" type="image/x-icon">
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
{{ htmlSnippet("head:end")|default("") }}
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
|
{{ htmlSnippet("body:start")|default("") }}
|
||||||
{% block style %}
|
{% block style %}
|
||||||
<link rel="stylesheet" href="{{ staticBase }}/style.css">
|
<link rel="stylesheet" href="{{ staticBase }}/style.css">
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
{% block content %}{% endblock %}
|
{% block content %}{% endblock %}
|
||||||
{% block javascript %}
|
{% block javascript %}
|
||||||
<script type="text/javascript">(function(e,b){if(!b.__SV){var a,f,i,g;window.mixpanel=b;b._i=[];b.init=function(a,e,d){function f(b,h){var a=h.split(".");2==a.length&&(b=b[a[0]],h=a[1]);b[h]=function(){b.push([h].concat(Array.prototype.slice.call(arguments,0)))}}var c=b;"undefined"!==typeof d?c=b[d]=[]:d="mixpanel";c.people=c.people||[];c.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};c.people.toString=function(){return c.toString(1)+".people (stub)"};i="disable track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config people.set people.set_once people.increment people.append people.track_charge people.clear_charges people.delete_user".split(" ");
|
|
||||||
for(g=0;g<i.length;g++)f(c,i[g]);b._i.push([a,e,d])};b.__SV=1.2;a=e.createElement("script");a.type="text/javascript";a.async=!0;a.src=("https:"===e.location.protocol?"https:":"http:")+'//cdn.mxpnl.com/libs/mixpanel-2.2.min.js';f=e.getElementsByTagName("script")[0];f.parentNode.insertBefore(a,f)}})(document,window.mixpanel||[]);
|
|
||||||
</script>
|
|
||||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/ace.js"></script>
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/ace.js"></script>
|
||||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/mode-javascript.js"></script>
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/mode-javascript.js"></script>
|
||||||
<script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script>
|
<script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script>
|
||||||
<script src="{{ staticBase }}/app.js"></script>
|
<script src="{{ staticBase }}/app.js"></script>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
{{ htmlSnippet("body:end")|default("") }}
|
||||||
</body>
|
</body>
|
||||||
|
{{ htmlSnippet("html:end")|default("") }}
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
{% extends "layout.html" %}
|
{% extends "layout.html" %}
|
||||||
|
|
||||||
|
{% block htmlTag %}{% if options.cache !== false %}manifest="{{ basePath }}/manifest.appcache"{% endif %}{% endblock %}
|
||||||
{% block title %}{{ progress.current.title }}{% parent %}{% endblock %}
|
{% block title %}{{ progress.current.title }}{% parent %}{% endblock %}
|
||||||
{% block content %}
|
{% block content %}
|
||||||
<div class="book" {% if githubId %}data-github="{{ githubId }}"{% endif %} data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">
|
<div class="book" {% if githubId %}data-github="{{ githubId }}"{% endif %} data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">
|
||||||
@@ -27,11 +28,39 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
{% if progress.current.prev and progress.current.prev.path %}
|
{% if progress.current.prev and progress.current.prev.path %}
|
||||||
<a href="{{ basePath }}/{{ progress.current.prev.path|mdLink }}" class="navigation navigation-prev"><i class="fa fa-angle-left"></i></a>
|
<a href="{{ basePath }}/{{ progress.current.prev.path|mdLink }}" class="navigation navigation-prev {% if !progress.current.next or !progress.current.next.path %}navigation-unique{% endif %}" aria-label="Previous page: {{ progress.current.prev.title }}"><i class="fa fa-angle-left"></i></a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% if progress.current.next and progress.current.next.path %}
|
{% if progress.current.next and progress.current.next.path %}
|
||||||
<a href="{{ basePath }}/{{ progress.current.next.path|mdLink }}" class="navigation navigation-next"><i class="fa fa-angle-right"></i></a>
|
<a href="{{ basePath }}/{{ progress.current.next.path|mdLink }}" class="navigation navigation-next {% if !progress.current.prev or !progress.current.prev.path %}navigation-unique{% endif %}" aria-label="Next page: {{ progress.current.next.title }}"><i class="fa fa-angle-right"></i></a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block javascript %}
|
||||||
|
{% parent %}
|
||||||
|
{% for resource in plugins.resources.js %}
|
||||||
|
{% if resource.url %}
|
||||||
|
<script src="{{ resource.url }}"></script>
|
||||||
|
{% else %}
|
||||||
|
<script src="{{ staticBase }}/plugins/{{ resource.path }}"></script>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
<script>
|
||||||
|
require(["gitbook"], function(gitbook) {
|
||||||
|
var config = {% autoescape false %}{{ pluginsConfig }}{% endautoescape %};
|
||||||
|
gitbook.start(config);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block style %}
|
||||||
|
{% parent %}
|
||||||
|
{% for resource in plugins.resources.css %}
|
||||||
|
{% if resource.url %}
|
||||||
|
<link rel="stylesheet" href="{{ resource.url }}">
|
||||||
|
{% else %}
|
||||||
|
<link rel="stylesheet" href="{{ staticBase }}/plugins/{{ resource.path }}">
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endblock %}
|
||||||
|
|||||||
Reference in New Issue
Block a user