Compare commits

...

24 Commits

Author SHA1 Message Date
Addison e350f4d8fc Update README.md 2023-03-02 13:30:09 +08:00
Addison 3492488236 Fix typo 2023-02-14 11:09:14 +01:00
Samy Pessé 6c6ef7f4af Add message about gitbook.com on README (#2170) 2018-12-27 17:51:39 +01:00
Johan Preynat 7bcd0438b5 Merge pull request #2115 from GitbookIO/remove-slack-link
Remove Slack link
2018-08-31 09:52:31 +00:00
Nicolas Gaborit 339b77071a Update README.md 2018-08-31 11:49:42 +02:00
Nicolas Gaborit 6efbb70c32 Update docs to become legacy (#2016)
* Update links to legacy.gitbook.com

* Update README.md

* Update README.md

* Update faq.md
2018-04-13 14:50:07 +02:00
Aaron O'Mullan b48f8472d3 Bump version to 3.2.3 2017-08-03 23:26:45 +02:00
Aaron O'Mullan fc46dab752 Update theme-default to 1.0.7 (fixes #1670) 2017-08-03 23:26:32 +02:00
Johan Preynat ad425b9772 Bump version to 3.2.2 2016-10-01 22:35:54 +02:00
Johan Preynat 5238fa352c Rollback to use gitbook-markdown@1.3.2 2016-10-01 22:30:43 +02:00
Johan Preynat 32183b6650 Merge branch 'fix-3.1-version' 2016-10-01 21:49:06 +02:00
Johan Preynat cb3d6a7f01 Correctly handle page parsing errors 2016-10-01 21:47:25 +02:00
Johan Preynat c978f0ab21 Add comment 2016-10-01 21:47:08 +02:00
Samy Pessé 33ff60cee7 Add changes for 3.2.1 2016-09-28 15:56:36 +02:00
Samy Pesse 33d7e022e6 Bump version to 3.2.1 2016-09-28 13:21:24 +02:00
Samy Pesse 09782b964b Update theme-default@1.0.6 2016-09-28 13:10:47 +02:00
Johan Preynat 7938ee8ec6 Use nunjucks@2.5.2 2016-09-28 10:32:14 +02:00
Peter B Smith 2e8e4f63d7 fixing a typo of the word "publishing" (#1536) 2016-09-28 09:49:29 +02:00
jdaviescoates b9fa6c3051 Update examples.md (#1522)
By adding the Loomio and Enspiral handbook examples
2016-09-08 20:38:59 +02:00
Samy Pessé 9c071dade5 Merge pull request #1481 from mcveat/patch-1
Fixed typo
2016-08-04 00:19:11 +02:00
Piotr Adamski 56e44651fa Fixed typo 2016-08-03 22:08:12 +02:00
Samy Pessé 42fac98992 Fix command for getting gitbook version 2016-08-01 09:47:31 +02:00
Samy Pessé 4f5513add0 Create template for GitHub issues 2016-07-25 20:39:31 +02:00
Samy Pesse 90cbfc0596 Add OSX testing on Travis 2016-07-15 11:38:58 +02:00
14 changed files with 106 additions and 47 deletions
+19
View File
@@ -0,0 +1,19 @@
Thank you for giving us your feedback! We listed some guidelines to help you:
If possible, open separate issues for each bug report. Avoid grouping bugs that are unrelated.
### What is the current behavior?
If the current behavior is a bug, please provide the steps to reproduce. if possible, provide the GitBook version being used (`gitbook -V`) and the system infromations (OS and version).
### What is the expected behavior?
How do you think, or how would you like it should behave.
#### For legacy.gitbook.com
Provide, if possible, your username and the URL of the concerned book.
----
The GitBook Team
+3
View File
@@ -1,5 +1,8 @@
sudo: false sudo: false
language: node_js language: node_js
os:
- linux
- osx
node_js: node_js:
- "stable" - "stable"
- "4.1" - "4.1"
+8
View File
@@ -2,6 +2,14 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/). This project adheres to [Semantic Versioning](http://semver.org/).
## 3.2.2
- Fix catching parsing errors leading to possible missing pages in generated book
- Rollback markdown parser to `kramed` until `markup-it` is stable enough
## 3.2.1
- Fix bug on Firefox when navigating to an url containing an hash
- Update nunjucks to fix JS error when page contains a lot of templating blocks
## 3.2.0 ## 3.2.0
- Switch markdown parser from `kramed` to `markup-it` - Switch markdown parser from `kramed` to `markup-it`
- Fix support of `|` in tables - Fix support of `|` in tables
+14 -6
View File
@@ -1,3 +1,11 @@
> ## ⚠️ Deprecation warning:
> As the efforts of the GitBook team are focused on the [GitBook.com](https://www.gitbook.com) platform, the CLI is no longer under active development.
> All content supported by the CLI are mostly supported by our [GitBook.com / GitHub integration](https://docs.gitbook.com/getting-started/git-sync).
> Content hosted on the [legacy.gitbook.com](https://legacy.gitbook.com) will continue working until further notice. For differences with the new version, > check out our [documentation](https://docs.gitbook.com/v2-changes/important-differences).
>
> Join our [GitHub community](https://github.com/GitbookIO/community) to stay up to date with the latest news at GitBook.
GitBook GitBook
======= =======
@@ -6,11 +14,11 @@ GitBook
[![Windows Build status](https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true)](https://ci.appveyor.com/project/GitBook/gitbook) [![Windows Build status](https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true)](https://ci.appveyor.com/project/GitBook/gitbook)
[![Slack Status](https://slack.gitbook.com/badge.svg)](https://slack.gitbook.com) [![Slack Status](https://slack.gitbook.com/badge.svg)](https://slack.gitbook.com)
GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [Learn Javascript](https://www.gitbook.com/book/GitBookIO/javascript). GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [Learn Javascript](https://legacy.gitbook.com/book/GitBookIO/javascript).
You can publish and host books easily online using [gitbook.com](https://www.gitbook.com). A desktop editor is [also available](https://www.gitbook.com/editor). You can publish and host books easily online using [gitbook.com](https://legacy.gitbook.com). A desktop editor is [also available](https://legacy.gitbook.com/editor).
Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook. Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
Complete documentation is available at [toolchain.gitbook.com](http://toolchain.gitbook.com/). Complete documentation is available at [toolchain.gitbook.com](http://toolchain.gitbook.com/).
@@ -18,7 +26,7 @@ Complete documentation is available at [toolchain.gitbook.com](http://toolchain.
## Getting started ## Getting started
GitBook can be used either on your computer for building local books or on GitBook.com for hosting them. To get started, check out [the installation instructions in the documentation](docs/setup.md). GitBook can be used either on your computer for building local books or on legacy.gitbook.com for hosting them. To get started, check out [the installation instructions in the documentation](docs/setup.md).
## Usage examples ## Usage examples
@@ -28,7 +36,7 @@ You can find a [list of real-world examples](docs/examples.md) in the documentat
## Help and Support ## Help and Support
We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook). We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://legacy.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
## Features ## Features
@@ -44,7 +52,7 @@ We're always happy to help out with your books or any other questions you might
## Publish your book ## Publish your book
The platform [GitBook.com](https://www.gitbook.com/) is like an "Heroku for books": you can create a book on it (public, or private) and update it using **git push**. The platform [legacy.gitbook.com](https://legacy.gitbook.com/) is like an "Heroku for books": you can create a book on it (public, or private) and update it using **git push**.
## Licensing ## Licensing
+7 -8
View File
@@ -1,20 +1,20 @@
# GitBook Toolchain Documentation # GitBook Toolchain Documentation
This document aims to be a comprehensive guide to GitBook. It contains the full documentation for version **{{ book.version }}**. Help for GitBook.com specific questions can be found at [help.gitbook.com](https://help.gitbook.com). This document aims to be a comprehensive guide to the GitBook command line tool, version **3.2.3**. This is the same toolchain used by the legacy GitBook platform, living at legacy.gitbook.com. Help for using the platform can be found at [help.legacy.gitbook.com](https://help.legacy.gitbook.com). If you are looking for the new GitBook service, head to [gitbook.com](https://www.gitbook.com).
### What is GitBook? ### What is `gitbook`?
GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). . This documentation has been generated using GitBook. `gitbook` is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). This documentation has been generated using `gitbook.
GitBook can output your content as a website ([customizable](themes/README.md) and [extensibles](plugins/README.md)) or as an ebook (PDF, ePub or Mobi). `gitbook` can output your content as a website ([customizable](themes/README.md) and [extensibles](plugins/README.md)) or as an ebook (PDF, ePub or Mobi).
[GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor). [legacy.gitbook.com](https://legacy.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://legacy.gitbook.com/editor).
### Help and Support ### Help and Support
We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook). If you have problems with the toolchain, you can search for or open a discussion on [GitHub](https://github.com/GitbookIO/gitbook).
Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook. Check out the [GitBook Community Slack Channel](https://slack.gitbook.com) for help, and stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
### FAQ ### FAQ
@@ -23,4 +23,3 @@ Some questions are frequently asked. If you have a problem you should [check th
### Contribute to this documentation ### Contribute to this documentation
You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes. You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes.
+3 -3
View File
@@ -8,9 +8,9 @@ GitBook allows you to customize your book using a flexible configuration. These
| -------- | ----------- | | -------- | ----------- |
| `root` | Path to the root folder containing all the book's files, except `book.json`| | `root` | Path to the root folder containing all the book's files, except `book.json`|
| `structure` | To specify paths for Readme, Summary, Glossary etc. See [Structure paragraph](#structure). | | `structure` | To specify paths for Readme, Summary, Glossary etc. See [Structure paragraph](#structure). |
| `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. | | `title` | Title of your book, default value is extracted from the README. On legacy.gitbook.com this field is pre-filled. |
| `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. | | `description` | Description of your book, default value is extracted from the README. On legacy.gitbook.com this field is pre-filled. |
| `author` | Name of the author. On GitBook.com this field is pre-filled. | | `author` | Name of the author. On legacy.gitbook.com this field is pre-filled. |
| `isbn` | ISBN of the book | | `isbn` | ISBN of the book |
| `language` | [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the book's language, default value is `en` | | `language` | [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the book's language, default value is `en` |
| `direction` | Text's direction. Can be `rtl` or `ltr`, the default value depends on the value of `language` | | `direction` | Text's direction. Can be `rtl` or `ltr`, the default value depends on the value of `language` |
+10 -8
View File
@@ -4,24 +4,26 @@ description: Real world examples of content published using GitBook.
# Examples # Examples
More than 50,000 books have been published on [GitBook.com](https://www.gitbook.com/explore). More than 50,000 books have been published on [legacy.gitbook.com](https://legacy.gitbook.com/explore).
### Books ### Books
- [Front-end Handbook](https://www.gitbook.com/book/frontendmasters/front-end-handbook/details) by [Cody Lindley](http://codylindley.com) - [Front-end Handbook](https://legacy.gitbook.com/book/frontendmasters/front-end-handbook/details) by [Cody Lindley](http://codylindley.com)
- [How to make an Operating System](https://www.gitbook.com/book/samypesse/how-to-create-an-operating-system/details) by [@SamyPesse](https://github.com/SamyPesse) - [How to make an Operating System](https://legacy.gitbook.com/book/samypesse/how-to-create-an-operating-system/details) by [@SamyPesse](https://github.com/SamyPesse)
- [Building Web Apps with Go](https://www.gitbook.com/book/codegangsta/building-web-apps-with-go/details) by [@codegangsta](https://github.com/codegangsta) - [Building Web Apps with Go](https://legacy.gitbook.com/book/codegangsta/building-web-apps-with-go/details) by [@codegangsta](https://github.com/codegangsta)
- [Django Girls Tutorial](http://tutorial.djangogirls.org/en/index.html) by [Django Girls](https://djangogirls.org) - [Django Girls Tutorial](http://tutorial.djangogirls.org/en/index.html) by [Django Girls](https://djangogirls.org)
- [Linux Inside](https://www.gitbook.com/book/0xax/linux-insides/details) by [0xAX](https://twitter.com/0xAX) - [Linux Inside](https://legacy.gitbook.com/book/0xax/linux-insides/details) by [0xAX](https://twitter.com/0xAX)
- [Learn Javascript](https://www.gitbook.com/book/gitbookio/javascript/details) by [GitBook](https://twitter.com/GitbookIO) - [Learn Javascript](https://legacy.gitbook.com/book/gitbookio/javascript/details) by [GitBook](https://twitter.com/GitbookIO)
### Research Papers ### Research Papers
- [TowCenter Collection](https://www.gitbook.com/@towcenter) by [Columbia Journalism School](http://www.journalism.columbia.edu/) - [TowCenter Collection](https://legacy.gitbook.com/@towcenter) by [Columbia Journalism School](http://www.journalism.columbia.edu/)
- [Block Relaxation Algorithms in Statistics](https://www.gitbook.com/@jandeleeuw) by Jan de Leeuw - [Block Relaxation Algorithms in Statistics](https://legacy.gitbook.com/@jandeleeuw) by Jan de Leeuw
### Documentation ### Documentation
- [DuckDuckHack Documentation](http://docs.duckduckhack.com) by [DuckDuckGo](https://duckduckgo.com/about) - [DuckDuckHack Documentation](http://docs.duckduckhack.com) by [DuckDuckGo](https://duckduckgo.com/about)
- [Loomio Handbook](http://loomio.coop/) by [Loomio](https://www.loomio.org/)
- [Enspiral Handbook](http://handbook.enspiral.com/) by [Enspiral](http://enspiral.com/)
- This documentation - This documentation
+4 -4
View File
@@ -2,15 +2,15 @@
This page gathers common questions and answers concerning the GitBook format and toolchain. This page gathers common questions and answers concerning the GitBook format and toolchain.
Questions about GitBook.com and the Editor are gather into the [help.gitbook.com's FAQ](http://help.gitbook.com/faq.html). Questions about the legacy platform at legacy.gitbook.com and the Editor are gather into the [help.legacy.gitbook.com's FAQ](http://help.legacy.gitbook.com/faq.html).
#### How can I host/publish my book? #### How can I host/publish my book?
Books can easily be published and hosted on [GitBook.com](https://www.gitbook.com). But GitBook output can be hosted on any static file hosting solution. Books can easily be published and hosted on [legacy.gitbook.com](https://legacy.gitbook.com). But GitBook output can be hosted on any static file hosting solution.
#### What can I use to edit my content? #### What can I use to edit my content?
Any text editor should work! But we advise using the [GitBook Editor](https://www.gitbook.com/editor). [GitBook.com](https://www.gitbook.com) also provides a web version of this editor. Any text editor should work! But we advise using the [GitBook Editor](https://legacy.gitbook.com/editor). [legacy.gitbook.com](https://legacy.gitbook.com) also provides a web version of this editor.
--- ---
@@ -34,7 +34,7 @@ You should always use paths and the `.md` extensions when linking to your files,
#### Can I create a GitBook in a sub-directory of my repository? #### Can I create a GitBook in a sub-directory of my repository?
Yes, GitBooks can be created in [sub-directories](structure.md#subdirectory). GitBook.com and the CLI also looks by default in a serie of [folders](structure.md). Yes, GitBooks can be created in [sub-directories](structure.md#subdirectory). legacy.gitbook.com and the CLI also looks by default in a serie of [folders](structure.md).
#### Does GitBook supports RTL languages? #### Does GitBook supports RTL languages?
+2 -2
View File
@@ -19,9 +19,9 @@ Once you find a plugin that you want to install, you need to add it to your `boo
You can also specify a specific version using: `"myPlugin@0.3.1"`. By default GitBook will resolve the latest version of the plugin compatbile with the current GitBook version. You can also specify a specific version using: `"myPlugin@0.3.1"`. By default GitBook will resolve the latest version of the plugin compatbile with the current GitBook version.
### GitBook.com ### legacy.gitbook.com
Plugins are automatically installed on [GitBook.com](https://www.gitbook.com). Locally, run `gitbook install` to install and prepare all plugins for your books. Plugins are automatically installed on [legacy.gitbook.com](https://legacy.gitbook.com). Locally, run `gitbook install` to install and prepare all plugins for your books.
### Configuring plugins ### Configuring plugins
+2 -2
View File
@@ -2,7 +2,7 @@
### Testing your plugin locally ### Testing your plugin locally
Testing your plugin on your book before plushing it is possible using [npm link](https://docs.npmjs.com/cli/link). Testing your plugin on your book before publishing it is possible using [npm link](https://docs.npmjs.com/cli/link).
In the plugin's folder, run: In the plugin's folder, run:
@@ -10,7 +10,7 @@ In the plugin's folder, run:
$ npm link $ npm link
``` ```
The nin your book's folder: Then in your book's folder:
``` ```
$ npm link gitbook-plugin-<plugin's name> $ npm link gitbook-plugin-<plugin's name>
+3 -3
View File
@@ -2,11 +2,11 @@
Getting GitBook installed and ready-to-go should only take a few minutes. Getting GitBook installed and ready-to-go should only take a few minutes.
### GitBook.com ### legacy.gitbook.com
[GitBook.com](https://www.gitbook.com) is an easy to use solution to write, publish and host books. It is the easiest solution for publishing your content and collaborating on it. [legacy.gitbook.com](https://legacy.gitbook.com) is an easy to use solution to write, publish and host books. It is the easiest solution for publishing your content and collaborating on it.
It integrates well with the [GitBook Editor](https://www.gitbook.com/editor). It integrates well with the [GitBook Editor](https://legacy.gitbook.com/editor).
### Local Installation ### Local Installation
+1
View File
@@ -9,6 +9,7 @@ var direction = require('direction');
* @return {Page} * @return {Page}
*/ */
function parsePageFromString(page, content) { function parsePageFromString(page, content) {
// Parse page YAML
var parsed = fm(content); var parsed = fm(content);
return page.merge({ return page.merge({
+25 -6
View File
@@ -11,15 +11,26 @@ var parsePage = require('./parsePage');
@param {Book} book @param {Book} book
@param {String} filePath @param {String} filePath
@return {Page} @return {Page?}
*/ */
function parseFilePage(book, filePath) { function parseFilePage(book, filePath) {
var fs = book.getContentFS(); var fs = book.getContentFS();
return fs.statFile(filePath) return fs.statFile(filePath)
.then(function(file) { .then(
var page = Page.createForFile(file); function(file) {
return parsePage(book, page); var page = Page.createForFile(file);
return parsePage(book, page);
},
function(err) {
// file doesn't exist
return null;
}
)
.fail(function(err) {
var logger = book.getLogger();
logger.error.ln('error while parsing page "' + filePath + '":');
throw err;
}); });
} }
@@ -48,9 +59,12 @@ function parsePagesList(book) {
return parseFilePage(book, filepath) return parseFilePage(book, filepath)
.then(function(page) { .then(function(page) {
map = map.set(filepath, page);
}, function() {
// file doesn't exist // file doesn't exist
if (!page) {
return;
}
map = map.set(filepath, page);
}); });
}) })
) )
@@ -65,6 +79,11 @@ function parsePagesList(book) {
return parseFilePage(book, file.getPath()) return parseFilePage(book, file.getPath())
.then(function(page) { .then(function(page) {
// file doesn't exist
if (!page) {
return;
}
map = map.set(file.getPath(), page); map = map.set(file.getPath(), page);
}); });
}) })
+5 -5
View File
@@ -1,7 +1,7 @@
{ {
"name": "gitbook", "name": "gitbook",
"version": "3.2.0", "version": "3.2.3",
"homepage": "https://www.gitbook.com", "homepage": "https://legacy.gitbook.com",
"description": "Library and cmd utility to generate GitBooks", "description": "Library and cmd utility to generate GitBooks",
"main": "lib/index.js", "main": "lib/index.js",
"browser": "./lib/browser.js", "browser": "./lib/browser.js",
@@ -22,14 +22,14 @@
"fresh-require": "1.0.3", "fresh-require": "1.0.3",
"front-matter": "^2.1.0", "front-matter": "^2.1.0",
"gitbook-asciidoc": "1.2.2", "gitbook-asciidoc": "1.2.2",
"gitbook-markdown": "2.0.1", "gitbook-markdown": "1.3.2",
"gitbook-plugin-fontsettings": "2.0.0", "gitbook-plugin-fontsettings": "2.0.0",
"gitbook-plugin-highlight": "2.0.2", "gitbook-plugin-highlight": "2.0.2",
"gitbook-plugin-livereload": "0.0.1", "gitbook-plugin-livereload": "0.0.1",
"gitbook-plugin-lunr": "1.2.0", "gitbook-plugin-lunr": "1.2.0",
"gitbook-plugin-search": "2.2.1", "gitbook-plugin-search": "2.2.1",
"gitbook-plugin-sharing": "1.0.2", "gitbook-plugin-sharing": "1.0.2",
"gitbook-plugin-theme-default": "1.0.5", "gitbook-plugin-theme-default": "1.0.7",
"github-slugid": "1.0.1", "github-slugid": "1.0.1",
"graceful-fs": "4.1.4", "graceful-fs": "4.1.4",
"i18n-t": "1.0.1", "i18n-t": "1.0.1",
@@ -44,7 +44,7 @@
"moment": "2.13.0", "moment": "2.13.0",
"npm": "3.9.2", "npm": "3.9.2",
"npmi": "2.0.1", "npmi": "2.0.1",
"nunjucks": "2.4.2", "nunjucks": "2.5.2",
"nunjucks-do": "1.0.0", "nunjucks-do": "1.0.0",
"object-path": "^0.9.2", "object-path": "^0.9.2",
"omit-keys": "^0.1.0", "omit-keys": "^0.1.0",