CHANGES.md

Release notes

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

4.0.0

• Breaking Changes: Most plugins and themes should be incompatible with this version
• GitBook rendering is now done using React, which brings better APIs for plugins and a more interactive website.
• Performances: Installation of plugins is much faster thanks to ied
• Performances: Git conrefs are faster over large books
• Website Feature: new default plugin copy-code to copy code blocks content in one click
• Website Feature: new default plugin heading-anchors to have clickable headings
• Website Feature: fontsettings is now only controlling the font size, and can work on multiple themes
• Plugin API: hook page can no longer modify the content, only the page's attributes
• Plugin API: plugins can no longer export resources, instead use the _assets folder
• Plugin API: testing framework
• gitbook init creates .gitignore if not found
• Ignore files are no longer copied to the output

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

• Switch markdown parser from kramed to markup-it
• Fix support of | in tables
• Fix access to output.name in templating
• Fix i18n for website and PDF
• Fix minor scrolling issues on website
• Improve options of default search indexer (keywords, disabling per pages)
• Improve pertinence of search results

3.1.1

• Fix order of plugins during loading
• Fix error when using math and conrefs
• Fix target attribute for external links
• Fix serve command

3.1.0

• Always load themes after plugins
• README/Introduction doesn't require to be the first entry in the summary
• Highlight active entry in summary when scrolling a page with anchors
• Support empty parts in summary

3.0.3

• Fix redirection in gitbook serve when accessing a folder without trailing slash
• Fix links/annotations for glossary not being correctly resolved
• Fix regression for supporting uppercase filenames in structure files
• Fix gitbook install when using Git URLs for plugins

3.0.2

• Fix crash for anchor links

3.0.1

• Fix regression in link resolution when contain anchor
• Fix structure.<name> configuration not supporting filenames with dots

3.0.0

• Summary can contain external links and anchors (Fix #776)
• Summary can contain differents entitled sections
• Glossary is generated as a normal page
• Headings are no longer annotated with glossary terms
• Themes are now published as a plugin, with ability to extend it from the book source
• links.sidebar configuration is no longer supported, use summary sections instead
• pdf.headerTemplate and pdf.footerTemplate have been replaced by a template in theme/book: _layouts/ebook/pdf_header.html and _layouts/ebook/pdf_footer.html
• Markdown parser is now using CommonMark
• Root folder for the book can be specified in the "root" property of the book.json file
• Multi-lingual books share assets folder
• YAML front matter is parsed and can extend page's properties
• Fix uk translation
• Fix heading ID including dashes
• Fix error in code highlighting for unknown languages
• Fix data-uri images being handled as external images
• Accept SSH url as plugin version
• Add templating blocks markdown, asciidoc and markup
• Better search experience
• Better default theme, more responsive and cleaner

2.6.7

• Fix bug with filenames including spaces
• Add Turkish and Catalan translations

2.6.6

• Fix custom CSS that are generated by plugins for PDF output

2.6.5

• Fix support for plugins generating custom stylesheets (styles-less and styles-sass)
• Fix glossary terms being replaced in script (ex: math)

2.6.4

• Fix regression introduced by 2.6.3 of single HTML tags in markdown

2.6.3

• Fix parsing bug with inline HTML in Markdown

2.6.2

• Fix gitbook.state.bookRoot, gitbook.state.root now has a trailing slash
• Update nunjucks to 2.2.0

2.6.1

• Use CamelCase for gitbook.state.innerLanguage

2.6.0

• Close sidebar after clicking a link on mobile
• Add root for multilingual books: gitbook.state.bookRoot
• Fix color of h6 headings
• Fix bottom margin of lists and blockquotes
• Add Swedish translation (sv)
• Add Czech translation (cs)
• Fix locale names for zh-hans and jp
• Update plugin search to fix crashes
• Aceept case-incensitive structure files (README, GLOSSARY, etc)

2.5.2

• Fix custom stylesheets for ebook generation
• Trigger event start before page.change

2.5.1

• Fix calcul of gitbook.state.root when serving HTML index as /

2.5.0

• Font settings, sharing and search are externalized as default plugins
• Plugins can define a configuration schema in the manifest, this schema will be used to validate configuration during build
• New Node.js API for plugin: book.formatString(type, content)
• New client side API for website plugins: gitbook.toolbar.createButton(opts)
• Better header/footer for PDF, CSS wil be inlined to easily style the header/footer
• Cleaner table of contents for ebooks
• Support for RTL in ebook's table of contents
• Better colors for mobi (links and code blocks)
• Fix installation of plugins when using a pre-release
• Fix support for pre-releases
• Update asciidoc parser to remove git dependency
• Fix templating in imported content
• Fix querystring in image urls
• Normalize heading IDs like GitHub
• Use Arial as default font for PDFs
• Add root, chapterTitle and filepath to gitbook.state JS API

2.4.3

• Add ukrainian translation (uk)
• Add book.json configuration for maximum size of search index
• Improve reliability of summary parser

2.4.2

• Default plugins should not be installed by gitbook install
• Limit search index size to avoid crash during generation
• Fix code highlighting for html without language specified
• Fix warning message for gitbook version when building a multilingual book

2.4.1

• Fix disabling of default plugins, ex: -highlight

2.4.0

• Fix page being updated when user wants to open a link in a new tab
• Plugins can now replaced default code highlighter
• Add semantic information for screen readers (web version)
• Content references accept absolute paths, resolved to book folder
• Improve overall reliability

2.3.3

• Fix bug in SUMMARY parsing preventing multiple entries without filenames

2.3.2

• Fix blocks (like maths) in Asciidoc
• Fix error when checking gitbook version

2.3.1

• Fix black font color for ebooks (mobi, pdf and epub)
• Fix ISO code for korean language
• Fix korean translation
• Fix syntax highlighting for asciidoc
• Fix inline html escaping in markdown
• Add warning for file outside SUMMARY
• Force SUMMARY entries to be unique by filename

2.3.0

• Fix nunjucks issue with multiple {% raw %} blocks
• Fix crash when git conref failed
• Fix crash when failed to download remote image (better error message)
• Fix flicking effect when changing page (big UX improvement)
• Add Hebrew translation (he)
• Add utility method book.config.get for plugins
• Hooks page:before and page are no longer deprecated
• Remove webfonts to make website lighter
• Make glossary's order case insensitive

2.2.0

• Fix direction in code blocks (always LTR)
• Add options chapterMark and pageBreaksBefore for PDF
• Update code highlighting library
• book.json accessible as config in templating syntax
• Add Vietnamese translation (vi)

2.1.0

• Fix error in calcul of levels in table of contents, error introduced a few versions ago
• Add optional styles/print.css to replace print.css used in ebook

2.0.4

• Fix {% raw %}, got confused with "fake" variable declarations
• Fix title of language chooser
• Fix the X-UA-Compatible meta tag
• Move style sheets to the section

2.0.3

• Fix gitbook init for SUMMARY with empty entries
• Fix escaping of code blocks in markdown

2.0.2

• Fix relative links in windows
• Improve watcher in serve command (switch to chokidar)
• Add Romanian translation (ro)
• Add Finish translation (fi)
• Add Japanese translation (jp)
• Add Korean translation (kr)

2.0.1

• Improve error logging (display file, line and column)
• Add back support for options.originalInput
• Don't process math in markdown parser (delegated to mathjax plugin)
• Fix some cases of code blocks escaping
• Fix i18n for introduction title in json format
• Fix reload when book configuration is updated
• Fix backslashes in url when building on windows

2.0.0

• Fix page title of introduction
• Ignore codeblocks when replacing glossary terms
• Improve Unit Tests
• Fix scrolling position in website when preparing page

2.0.0-beta.5

• Fix progress order in json format

2.0.0-beta.4

• Fix default generator for use programmatically
• Add option "author" for html meta tags
• Fix links normalization (content and hash)

2.0.0-beta.3

• Fix odd cases with code blocks escaping

2.0.0-beta.2

• Fix definition of entry point title using SUMMARY.md

2.0.0-beta.1

• Fix windows incompatibility
• Add support for rtl (enabled by default for ar and fa)
• Escape code blocks in markdown parser
• Add Persian/Farsi translation (fa)
• Add Arabic translation (ar)
• Add Bengali translation (bn)
• Provide generator name in template context

2.0.0-alpha.9

• Fix links in sidebar
• Fix normalization of html link (README to index)
• Fix html snippets escaping

2.0.0-alpha.8

• Improve locale detection for i18n
• Fix chapter name for Glossary in pdf
• Don't escape html in glossary items
• Fix generation of multilingual book as ebook
• Add "post" block attribute to post-process

2.0.0-alpha.7

• Fix display of glossary in ebook formats
• Add default footer and header to pdf
• Fix generation of json format compatible with 1.x.x
• Add Simplifiled Chinese and Traditional Chinese translations

2.0.0-alpha.6

• Add es and pt translations
• Fix replacement of glossary terms

2.0.0-alpha.5

• Fix copy of files/covers
• Add back finish:before hook

2.0.0-alpha.4

• Fix copy of cover for multilingal books

2.0.0-alpha.3

• Norwegian translation
• Load plugins from book in priority

2.0.0-alpha.3

• Fix init command
• Update parsers to fix spaces in summary ([email protected])

2.0.0-alpha.1

• Externalize parsing into gitbook-parsers module
• Supports AsciiDoc and reStructuredText
• Hooks for page (page:*) are now deprecated, plugins should extend filters and blocks instead
• Hooks summary and glossary (after and before) have been removed
• Exercises and Quizzes are no longer parsed in the markdown parser
• Support for more markdown extensions: .markdown, .mdown
• Templates are rendered with nunjucks instead of swig, syntax is almost compatible, there is some changes with contexts and filters. {{ super() }} should be use instead of {% parent %}
• Clean output folder on build without removing .git and .svn
• MathJAX is no longer a default plugin
• SVG images are converted to PNG during generation of ebooks
• i18n in website and ebook (ru, it, de, fr)
• New templating syntax
• Content references (both internal and external)
• Glossary terms are handled during generation (also in ebook format)

1.5.0

• Fix serve command, broken by 1.4.2
• Add nicer dark theme :)

1.4.2

• Force process.exit after builds, to prevent (possibly) lingering plugins

1.4.1

• Fix command 'install' without arguments

1.4.0

• Add command gitbook install to install plugins from book.json
• package.json is no longer necessary

1.3.4

• Add glossary to ebooks
• Fix autocover with new hook "finish:before"
• Add X-UA-Compatible meta tag for IE

1.3.3

• Fix parsing of lexed content using the client library

1.3.2

• ePub files are now passing validation from epubcheck
• Fix replacement of multiple glossary terms in a single sentence
• Fix on windows deep relative links
• Fix search indexer

1.3.1

• Fix error with links in markdown

1.3.0

• Bundle gitbook parsing library as a client side library in gitbook.js and gitbook.min.js

1.2.0

• Improvements on ebook generation
• Fix incorrect follow of links in ebook generation
• Move Table of Contents at the beginning of the ebook
• Update to last highlight.js (includes Swift)
• Includes of templates and variables (from book.json)

1.1.1

• Rewrite quiz logic to be more robust
• Improve integration of glossary
• Improve generation of ebook by using a multiple HTML pages input source
• Fix incorrect page breaks after h1 and h2 divs
• New options to set header and footer in PDF generation

1.1.0

• Plugins can now extend the ebook generation (pdf, epub, mobi)
• Update kramed to version 0.4.3

1.0.3

• Update mathjax plugin and MathJAx to version 2.4
• Update highlight.js to 8.2.0

1.0.2

• Update mathjax plugin, fixes issues with inline math rendering (no longer wanted)

1.0.1

• New inline math convention (kramdown's), using $$ rather than $ as delimiters
• Fix instapaper sharing
• The exercises & quizzes plugins are now by default

1.0.0

• New design
• Support for glossary
• Support for sharing to instapaper
• Support for footnotes

0.7.1

• Update fs-extra to 0.10.0 (fixes potential race conditions)

0.7.0

• Add page break in ebook (pdf, epub, mobi) between chapters/articles
• Start using kramed instead of marked
• Fix display of inline math
• Switch to graceful-fs to fix EMFILE errors
• Add sharing to weibo.com

0.6.2

• Support generating a plugin's book info dynamically
• Improve navigation on dark theme
• Improve path normalization when parsing SUMMARY.md

0.6.0

• Generate header id the same as github
• Custom links can be added at top of sidebar
• Summary can now be transformed by plugins
• Support importing code snippets