Switch to markup-it for parsing (GitbookIO#1659)

* Start new parsers in gitbook itself

* Update markup-it

* Fix eslint errors

* Adapt basic parsing for summary

* Start tests for summaryFromDocument

* Continue

* Add parsing of glossary

* Add back languages parsing

* Adapt most tests for parsing

* Adapt all tests 🙌

* Adapt travis tests

* Bootstrap lerna before running tests

* Fix lowercase in require (linux)

* Fix command gitbook init

* Fix generation of ready by init command

* Fix generation of summary

* Fix watch after serve

* Add trademark to sidebar

* Add back favicon to default theme

* Open trademark in new tab

Author: SamyPesse

.travis.yml

@@ -8,5 +8,7 @@ node_js:
   - "4.1"
 before_install:
   - npm install svgexport -g
+before_script:
+  - npm run bootstrap
 after_success:
   - npm run lint

package.json

@@ -1,11 +1,9 @@
 {
   "private": true,
   "devDependencies": {
-    "eslint": "3.4.0",
-    "eslint-config-gitbook": "1.3.1",
-    "expect": "^1.20.1",
-    "lerna": "2.0.0-beta.31",
-    "mocha": "^2.4.5"
+    "eslint": "3.12.2",
+    "eslint-config-gitbook": "1.5.0",
+    "lerna": "2.0.0-beta.31"
   },
   "scripts": {
     "lint": "eslint .",

packages/gitbook-core/src/components/Image.js

@@ -0,0 +1,37 @@
+const React = require('react');
+const ReactRedux = require('react-redux');
+
+const File = require('../models/File');
+const FileShape = require('../propTypes/File');
+
+/**
+ * Local image. Using this component instead of <img>
+ * avoid broken links when location changes.
+ *
+ * @type {ReactClass}
+ */
+const Image = React.createClass({
+    propTypes: {
+        currentFile: FileShape,
+        src: React.PropTypes.oneOfType([
+            React.PropTypes.string,
+            FileShape
+        ])
+    },
+
+    render() {
+        let { src, currentFile, ...props } = this.props;
+        delete props.dispatch;
+
+        if (File.is(src)) {
+            src = src.url;
+        }
+
+        src = currentFile.relative(src);
+        return <img src={src} {...props} />;
+    }
+});
+
+module.exports = ReactRedux.connect((state) => {
+    return { currentFile: state.file };
+})(Image);

packages/gitbook-core/src/components/InjectedComponent.js

@@ -53,6 +53,8 @@ const InjectedComponentSet = React.createClass({
 
     render() {
         const { components, props, children, ...divProps } = this.props;
+        delete divProps.matching;
+        delete divProps.dispatch;
 
         const inner = components.map((Comp, i) => <Injection key={i} component={Comp} props={props} />);
 

packages/gitbook-core/src/components/Link.js

@@ -6,6 +6,12 @@ const SummaryArticle = require('../models/SummaryArticle');
 const SummaryArticleShape = require('../propTypes/SummaryArticle');
 const FileShape = require('../propTypes/File');
 
+/**
+ * Link to another page or file in the book. Using this component instead of <a>
+ * avoid broken links when location changes.
+ *
+ * @type {ReactClass}
+ */
 const Link = React.createClass({
     propTypes: {
         currentFile: FileShape,
@@ -22,6 +28,7 @@ const Link = React.createClass({
     render() {
         const { currentFile, to, children, ...props } = this.props;
         let href = to;
+        delete props.dispatch;
 
         if (SummaryArticle.is(to) || File.is(to)) {
             href = to.url;
@@ -32,6 +39,6 @@ const Link = React.createClass({
     }
 });
 
-module.exports = ReactRedux.connect(state => {
+module.exports = ReactRedux.connect((state) => {
     return { currentFile: state.file };
 })(Link);

packages/gitbook-core/src/index.js

@@ -12,6 +12,7 @@ const { InjectedComponent, InjectedComponentSet } = require('./components/Inject
 const { ImportLink, ImportScript, ImportCSS } = require('./components/Import');
 const HTMLContent = require('./components/HTMLContent');
 const Link = require('./components/Link');
+const Image = require('./components/Image');
 const Icon = require('./components/Icon');
 const HotKeys = require('./components/HotKeys');
 const Button = require('./components/Button');
@@ -56,6 +57,7 @@ module.exports = {
     FlexLayout: Flex,
     FlexBox: Box,
     Link,
+    Image,
     Icon,
     HotKeys,
     Button,

packages/gitbook-core/src/lib/renderWithContext.js

@@ -5,7 +5,7 @@ const PJAXWrapper = require('../components/PJAXWrapper');
 const I18nProvider = require('../components/I18nProvider');
 const ContextProvider = require('../components/ContextProvider');
 const History = require('../actions/history');
-const contextShape = require('../propTypes/context');
+const contextShape = require('../propTypes/Context');
 
 const GitBookApplication = React.createClass({
     propTypes: {

packages/gitbook-core/src/models/Page.js

@@ -12,7 +12,7 @@ const DEFAULTS = {
 };
 
 class Page extends Record(DEFAULTS) {
-    static create(state) {
+    static create(state = {}) {
         return state instanceof Page ?
             state : new Page({
                 ...state,

packages/gitbook-plugin-theme-default/.gitignore

@@ -1 +1,2 @@
-_assets
+_assets/**/*
+!_assets/website/images

packages/gitbook-plugin-theme-default/_assets/website/images/favicon.ico

@@ -27,3 +27,28 @@
     border-right: 1px solid @sidebar-border-color;
     overflow-y: auto;
 }
+
+.GitBookTrademark {
+    text-align: center;
+    text-decoration: none;
+    opacity: 0.1;
+    margin-top: 80px;
+    margin-bottom: 40px;
+    color: #000;
+    display: block;
+
+    &:hover {
+        text-decoration: none;
+        opacity: 0.2;
+    }
+
+    span {
+        display: block;
+    }
+
+    img {
+        max-width: 64px;
+        filter: grayscale(100%);
+        margin-top: 10px;
+    }
+}

packages/gitbook-plugin-theme-default/_assets/website/images/logo.svg

@@ -3,6 +3,25 @@ const { React } = GitBook;
 
 const Summary = require('./Summary');
 
+/**
+ * The GitBook trademark.
+ * @type {ReactClass}
+ */
+const GitBookTrademark = React.createClass({
+    render() {
+        return (
+            <a className="GitBookTrademark" href="https://www.gitbook.com/?utm_source=gitbook&utm_medium=trademark" target="_blank">
+                <span>Published with <b>GitBook</b></span>
+                <GitBook.Image src="gitbook/theme-default/images/logo.svg" />
+            </a>
+        );
+    }
+});
+
+/**
+ * Sidebar containing a serch bar, the table of contents, and the GitBook trademark.
+ * @type {ReactClass}
+ */
 const Sidebar = React.createClass({
     propTypes: {
         summary: GitBook.PropTypes.Summary
@@ -16,6 +35,8 @@ const Sidebar = React.createClass({
                 <div className="Sidebar book-summary">
                     <GitBook.InjectedComponent matching={{ role: 'search:container:input' }} />
                     <Summary summary={summary} />
+
+                    <GitBookTrademark />
                 </div>
             </div>
         );

packages/gitbook-plugin-theme-default/less/Sidebar.less

@@ -8,6 +8,7 @@ const LoadingBar = require('./LoadingBar');
 const Theme = React.createClass({
     propTypes: {
         // State
+        file:     GitBook.PropTypes.File,
         page:     GitBook.PropTypes.Page,
         summary:  GitBook.PropTypes.Summary,
         readme:   GitBook.PropTypes.Readme,
@@ -18,14 +19,18 @@ const Theme = React.createClass({
     },
 
     render() {
-        const { page, summary, children, sidebar, readme, history } = this.props;
+        const { file, page, summary, children, sidebar, readme, history } = this.props;
 
         return (
             <GitBook.FlexLayout column className="GitBook book">
                 <LoadingBar show={history.loading} />
                 <GitBook.Head
                     title={page.title}
-                    titleTemplate="%s - GitBook" />
+                    titleTemplate="%s - GitBook"
+                    link={[
+                        {rel: 'shortcut icon', href: file.relative('gitbook/theme-default/images/favicon.ico')}
+                    ]}
+                />
                 <GitBook.ImportCSS href="gitbook/theme-default/theme.css" />
 
                 <GitBook.FlexBox>
@@ -52,6 +57,6 @@ const Theme = React.createClass({
     }
 });
 
-module.exports = GitBook.connect(Theme, ({page, summary, sidebar, readme, history}) => {
-    return { page, summary, sidebar, readme, history };
+module.exports = GitBook.connect(Theme, ({file, page, summary, sidebar, readme, history}) => {
+    return { file, page, summary, sidebar, readme, history };
 });

packages/gitbook-plugin-theme-default/src/components/Sidebar.js

@@ -0,0 +1,3 @@
+{
+    "presets": ["es2015", "stage-2"]
+}

packages/gitbook-plugin-theme-default/src/components/Theme.js

@@ -6,6 +6,7 @@
   "main": "lib/index.js",
   "browser": "./lib/browser.js",
   "dependencies": {
+    "asciidoctor.js": "^1.5.5-4",
     "bash-color": "0.0.4",
     "cheerio": "0.20.0",
     "chokidar": "1.5.0",
@@ -21,9 +22,7 @@
     "extend": "^3.0.0",
     "fresh-require": "1.0.3",
     "front-matter": "^2.1.0",
-    "gitbook-asciidoc": "1.2.2",
     "gitbook-core": "4.0.0",
-    "gitbook-markdown": "1.3.2",
     "gitbook-plugin-copy-code": "4.0.0",
     "gitbook-plugin-headings": "4.0.0",
     "gitbook-plugin-highlight": "4.0.0",
@@ -44,6 +43,7 @@
     "json-schema-defaults": "0.1.1",
     "jsonschema": "1.1.0",
     "juice": "2.0.0",
+    "markup-it": "3.3.0",
     "mkdirp": "0.5.1",
     "moment": "2.13.0",
     "npm": "3.10.9",
@@ -59,13 +59,24 @@
     "rmdir": "1.2.0",
     "semver": "5.1.0",
     "send": "0.13.2",
+    "slate": "^0.16.8",
     "spawn-cmd": "0.0.2",
     "tiny-lr": "0.2.1",
     "tmp": "0.0.28",
     "urijs": "1.18.0"
   },
+  "devDependencies": {
+    "babel-cli": "^6.18.0",
+    "babel-preset-es2015": "^6.18.0",
+    "babel-preset-react": "^6.16.0",
+    "babel-preset-stage-2": "^6.18.0",
+    "babel-register": "^6.18.0",
+    "expect": "^1.20.2",
+    "mocha": "^3.2.0",
+    "read-metadata": "^1.0.0"
+  },
   "scripts": {
-    "test": "./node_modules/.bin/mocha ./testing/setup.js \"./src/**/*/__tests__/*.js\" --bail --reporter=list --timeout=100000 --compilers js:babel-register",
+    "test": "mocha ./testing/setup.js \"./src/**/*/__tests__/*.js\" --bail --reporter=list --timeout=100000 --compilers js:babel-register",
     "dist": "rm -rf lib/ && babel -d lib/ src/ --source-maps --ignore \"**/*/__tests__/*.js\"",
     "prepublish": "npm run dist"
   },
@@ -95,13 +106,5 @@
       "name": "Samy Pessé",
       "email": "[email protected]"
     }
-  ],
-  "devDependencies": {
-    "babel-cli": "^6.14.0",
-    "babel-preset-es2015": "^6.14.0",
-    "babel-preset-react": "^6.11.1",
-    "babel-preset-stage-2": "^6.13.0",
-    "babel-register": "^6.14.0",
-    "mocha": "^3.0.2"
-  }
+  ]
 }

packages/gitbook-plugin/.babelrc

@@ -1,8 +1,8 @@
 const gitbook = require('../gitbook');
 
-describe('satisfies', function() {
+describe('satisfies', () => {
 
-    it('should return true for *', function() {
+    it('should return true for *', () => {
         expect(gitbook.satisfies('*')).toBe(true);
     });
 

packages/gitbook/package.json

@@ -1,13 +1,13 @@
 const tmp = require('tmp');
 const initBook = require('../init');
 
-describe('initBook', function() {
+describe('initBook', () => {
 
-    it('should create a README and SUMMARY for empty book', function() {
+    it('should create a README and SUMMARY for empty book', () => {
         const dir = tmp.dirSync();
 
         return initBook(dir.name)
-        .then(function() {
+        .then(() => {
             expect(dir.name).toHaveFile('README.md');
             expect(dir.name).toHaveFile('SUMMARY.md');
         });

packages/gitbook/src/__tests__/gitbook.js

@@ -1,6 +1,6 @@
 
-describe('GitBook', function() {
-    it('should correctly export', function() {
+describe('GitBook', () => {
+    it('should correctly export', () => {
         require('../');
     });
 });