Merge pull request #1360 from ehuss/release-next

Release 0.4.4

.gitattributes

@@ -2,3 +2,7 @@
 
 * text=auto eol=lf
 *.rs rust
+*.woff binary
+*.ttf binary
+*.otf binary
+*.png binary

.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+name: Deploy
+on:
+  release:
+    types: [created]
+
+jobs:
+  release:
+    name: Deploy Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+    - uses: actions/checkout@master
+    - name: Install hub
+      run: ci/install-hub.sh ${{ matrix.os }}
+      shell: bash
+    - name: Install Rust
+      run: ci/install-rust.sh stable
+      shell: bash
+    - name: Build and deploy artifacts
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: ci/make-release.sh ${{ matrix.os }}
+      shell: bash
+  pages:
+    name: GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Install Rust (rustup)
+      run: rustup update stable --no-self-update && rustup default stable
+    - name: Build book
+      run: cargo run -- build guide
+    - name: Deploy to GitHub
+      env:
+        GITHUB_DEPLOY_KEY: ${{ secrets.GITHUB_DEPLOY_KEY }}
+      run: |
+        touch guide/book/.nojekyll
+        curl -LsSf https://raw.githubusercontent.com/rust-lang/simpleinfra/master/setup-deploy-keys/src/deploy.rs | rustc - -o /tmp/deploy
+        cd guide/book
+        /tmp/deploy

.github/workflows/main.yml

@@ -0,0 +1,51 @@
+name: CI
+on:
+  # Only run when merging to master, or open/synchronize/reopen a PR.
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        build: [stable, beta, nightly, macos, windows, msrv]
+        include:
+          - build: stable
+            os: ubuntu-latest
+            rust: stable
+          - build: beta
+            os: ubuntu-latest
+            rust: beta
+          - build: nightly
+            os: ubuntu-latest
+            rust: nightly
+          - build: macos
+            os: macos-latest
+            rust: stable
+          - build: windows
+            os: windows-latest
+            rust: stable
+          - build: msrv
+            os: ubuntu-latest
+            rust: 1.39.0
+    steps:
+    - uses: actions/checkout@master
+    - name: Install Rust
+      run: bash ci/install-rust.sh ${{ matrix.rust }}
+    - name: Build and run tests
+      run: cargo test
+    - name: Test no default
+      run: cargo test --no-default-features
+
+  rustfmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Install Rust
+      run: rustup update stable && rustup default stable && rustup component add rustfmt
+    - run: cargo fmt -- --check

.gitignore

@@ -1,5 +1,17 @@
-Cargo.lock
 target
 
+# MacOS temp file
+.DS_Store
+
 book-test
-book-example/book
+guide/book
+
+.vscode
+tests/dummy_book/book/
+
+# Ignore Jetbrains specific files.
+.idea/
+
+# Ignore Vim temporary and swap files.
+*.sw?
+*~

.travis.yml

@@ -1,101 +0,0 @@
-sudo: false
-
-language: generic
-
-env:
-  global:
-    - PROJECT_NAME=mdBook
-    - secure: l3/qEC4krRerllLQzni8j5AjngFi6pluWvBWj//1mJLoIEYwxlQ9mYxEdd9BqccWWFn3K0bVYCVC/64+tP6sRfLkZCe2gPUtwe7ITwCDbapUxmkiRObVJCs5yMQZt6idyhHUDKAXKgNCrusfI2BM3tKGBfRK7Cnn/R/7p/U9+q7D1sgJtUKp6ypVzK6A3jLNp3dFLFI19a5KmbZMVsaa7tOhtdDJjjr7ebsc9z7HMW5/OItiWU3FSauVQQlUMaCiEgFuIG7H7OnBAYWB/gNEtLuwfLqU9UjtWk/njNNRnmJ7m3y5HbQhv5H5F5mJUOq9XFlPLwPwyTeVztSGdQm6k8Pp2pgKBUjY27afBl9BWU+msmN6k0oXfhvIebiBPe/x2udiKeFik1xqOOEU1q9dF0sZiuPxCSM1n7tgWklJ8epgaRQaMPPQw9pO/2H5/ynHCJqBlw6WcdiqWtwAyyr/GEx62u/cg5IVkqb7KLmYsWzjS8wYG4CYs1eIxCw2xPZxP0FGuUXvxTBUPipFze6Z7FqxVauXtVe2D7c1P4738HZP660rmR0GYtHtKLny1QxCCK9sxd9JmcezFCSz4YeQ1od9xc0OzGJ2ullKNGizmGfYmgL6X8faNylLIEdaiHAcY16xV3L0g3fXL1Qg360UHQyj7GIv+0nqQnf+H9xRTTU=
-
-matrix:
-  include:
-    # Stable channel
-    - os: osx
-      env: TARGET=i686-apple-darwin CHANNEL=stable
-    - os: linux
-      env: TARGET=i686-unknown-linux-gnu CHANNEL=stable
-      addons:
-        apt:
-          packages: &i686_unknown_linux_gnu
-            - gcc-multilib
-    - os: osx
-      env: TARGET=x86_64-apple-darwin CHANNEL=stable
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-gnu CHANNEL=stable
-      addons:
-        apt:
-          packages:
-            - nodejs
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=stable
-    # Beta channel
-    - os: osx
-      env: TARGET=i686-apple-darwin CHANNEL=beta
-    - os: linux
-      env: TARGET=i686-unknown-linux-gnu CHANNEL=beta
-      addons:
-        apt:
-          packages: *i686_unknown_linux_gnu
-    - os: osx
-      env: TARGET=x86_64-apple-darwin CHANNEL=beta
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-gnu CHANNEL=beta
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=beta
-    # Nightly channel
-    - os: osx
-      env: TARGET=i686-apple-darwin CHANNEL=nightly
-    - os: linux
-      env: TARGET=i686-unknown-linux-gnu CHANNEL=nightly
-      addons:
-        apt:
-          packages: *i686_unknown_linux_gnu
-    - os: osx
-      env: TARGET=x86_64-apple-darwin CHANNEL=nightly
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-gnu CHANNEL=nightly
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=nightly
-
-  # Musl builds fail due to a bug in Rust (https://github.com/azerupi/mdBook/issues/158)
-  allow_failures:
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=stable
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=beta
-    - os: linux
-      env: TARGET=x86_64-unknown-linux-musl CHANNEL=nightly
-
-install:
-  - export PATH="$PATH:$HOME/.cargo/bin"
-  - bash ci/install.sh
-
-script:
-  - bash ci/script.sh
-
-after_success:
-  - test "$TRAVIS_PULL_REQUEST" == "false" &&
-    test "$TRAVIS_BRANCH" == "master" &&
-    test "$TARGET" == "x86_64-unknown-linux-gnu" &&
-    test "$CHANNEL" = "stable" &&
-    npm install stylus nib &&
-    bash deploy.sh
-
-before_deploy:
-  - bash ci/before_deploy.sh
-
-deploy:
-  provider: releases
-  api_key:
-    secure: Z1k7WqX7z+tT4+SzTh4tBBzf11VaADB4AWuEczHtylaEb/0hRs8gaiHCNSVHm/QTp0QPWQR2Vw7uKMhVuxG7I8X7h31j3A7ulYBh/iVk0DVIrtrn2Q4WOED9CpoXLuLtk2nxo9MBViFW7mw4nJe9H2Tn9o/9oEYBuwzekvW5mh4muqUuCVTr8eQVYbs3jbC9pQy5oYjOLeUnlL9Cey5VN/nAhzAtyFP+6lIMri0PKit4JtkFou/O1MEpFYlP3VGC2lFiWuByocPKBT/L45FecS9qoHq+i6+ZCPDH2eu46nuYsDbLKAkPdGvf1MdPBPwoj0vSnZbgaTisQ4hIoBngQQQPZlPaGtcdd6g6asxSfnbA9cQhClI5oZJmg+ksxQE+peE8pnbmZ10Ix0PpIkkfWdQeMdUUCQarOTkTK54Munw+X+kp1lH19j6+krQPLBYr95fPRd4b5tWsJD2+pb/UOYFEEJxMNoUHyLCrtdCO7imOwrSUcv51+Z8UudqfPpKQeszrJcntL4owip35r3sF5TsE9YfW5qssLC164IylvP32y1AcfL1jqg8b+zrqLZKanjvDOJ1dtHHuwKqxcwf7PhAf0YjAtVSH9OIYcDzmDa0EMLrq7EK0fs6NAeb5qt6CML7pZrRS3fmOxN53Fbmj81qm6TmjQjDe4dmZlELgNow=
-  file: ${PROJECT_NAME}-${TRAVIS_TAG}-${TARGET}.tar.gz
-  # don't delete the artifacts from previous phases
-  skip_cleanup: true
-  # deploy when a new tag is pushed
-  on:
-    condition: $CHANNEL = stable
-    tags: true
-
-notifications:
-  email:
-    on_success: never

CHANGELOG.md

@@ -0,0 +1,538 @@
+# Changelog
+
+## mdBook 0.4.4
+[4df9ec9...01836ba](https://github.com/rust-lang/mdBook/compare/4df9ec9...01836ba)
+
+### Added
+- Added the `output.html.print.enable` configuration value to disable the
+  "print" page.
+  [#1169](https://github.com/rust-lang/mdBook/pull/1169)
+- Added a list of supported languages for syntax-highlighting to the
+  documentation.
+  [#1345](https://github.com/rust-lang/mdBook/pull/1345)
+
+### Fixed
+- Now supports symbolic links for files in the `src` directory.
+  [#1323](https://github.com/rust-lang/mdBook/pull/1323)
+
+## mdBook 0.4.3
+[9278b83...4df9ec9](https://github.com/rust-lang/mdBook/compare/9278b83...4df9ec9)
+
+### Added
+- Added `output.html.cname` option to emit a `CNAME` file which is used by
+  GitHub Pages to know which domain is being used.
+  [#1311](https://github.com/rust-lang/mdBook/pull/1311)
+
+### Changed
+- `mdbook test` no longer stops on the first test failure, but instead will
+  run all the tests.
+  [#1313](https://github.com/rust-lang/mdBook/pull/1313)
+- Removed the `local` font source for Source Code Pro, as the locally
+  installed font may not render properly on FireFox on macOS.
+  [#1307](https://github.com/rust-lang/mdBook/pull/1307)
+
+### Fixed
+- Added newline to end of `.nojekyll` file.
+  [#1310](https://github.com/rust-lang/mdBook/pull/1310)
+- Fixed missing space before draft chapter titles.
+  [#1309](https://github.com/rust-lang/mdBook/pull/1309)
+
+## mdBook 0.4.2
+[649f355...9278b83](https://github.com/rust-lang/mdBook/compare/649f355...9278b83)
+
+### Changed
+- The "show hidden lines" icon has changed from the "expand" icon to an "eye".
+  [#1281](https://github.com/rust-lang/mdBook/pull/1281)
+- Updated highlight.js. This adds several languages: c, c-like (effectively
+  cpp), csharp (replaces cs), kotlin, less, lua, php-template, plaintext,
+  python-repl, r, scss, typescript.
+  [#1277](https://github.com/rust-lang/mdBook/pull/1277)
+
+### Fixed
+- Fixed SUMMARY links that contained newlines.
+  [#1291](https://github.com/rust-lang/mdBook/pull/1291)
+- Fixed SUMMARY links that contain `%20` spaces.
+  [#1293](https://github.com/rust-lang/mdBook/pull/1293)
+- Fixed favicon so that if only the png or svg is overridden, the other is not
+  automatically included in the `<link>` tag.
+  [#1272](https://github.com/rust-lang/mdBook/pull/1272)
+
+## mdBook 0.4.1
+[d4df7e7...649f355](https://github.com/rust-lang/mdBook/compare/d4df7e7...649f355)
+
+### Changed
+- Removed several outdated dev-dependencies.
+  [#1267](https://github.com/rust-lang/mdBook/pull/1267)
+
+### Fixed
+- Fixed sidebar scrolling if the book includes part titles.
+  [#1265](https://github.com/rust-lang/mdBook/pull/1265)
+- Don't include the default favicon if only one of the PNG or SVG is overridden.
+  [#1266](https://github.com/rust-lang/mdBook/pull/1266)
+
+## mdBook 0.4.0
+[99ecd4f...d4df7e7](https://github.com/rust-lang/mdBook/compare/99ecd4f...d4df7e7)
+
+### Breaking Changes
+- Several of the changes in the release have altered the public API of the
+  mdbook library.
+- Many dependencies have been updated or replaced.
+  This also removes the `--websocket-hostname` and `--websocket-port` from
+  the `serve` command.
+  [#1211](https://github.com/rust-lang/mdBook/pull/1211)
+- A new "404" page is now automatically rendered. This requires knowledge of
+  the base URL of your site to work properly. If you decide to use this as
+  your 404 page, you should set the `site-url` setting in the book
+  configuration so mdbook can generate the links correctly. Alternatively you
+  can disable the 404 page generation, or set up your own 404 handling in your
+  web server.
+  [#1221](https://github.com/rust-lang/mdBook/pull/1221)
+- The `debug` and `output` features have been removed as they were unused.
+  [#1211](https://github.com/rust-lang/mdBook/pull/1211)
+- If you are using customized themes, you may want to consider setting the
+  `preferred-dark-theme` config setting, as it now defaults to "navy".
+  [#1199](https://github.com/rust-lang/mdBook/pull/1199)
+- "Playpen" has been renamed to "playground". This is generally backwards
+  compatible for users, but `{{#playpen}}` will now display warnings. This may
+  impact books that have modified the "playpen" elements in the theme.
+  [#1241](https://github.com/rust-lang/mdBook/pull/1241)
+- If a renderer is not installed, it is now treated as an error. If you want
+  the old behavior of ignoring missing renderers, set the `optional` setting
+  for that renderer.
+  [#1122](https://github.com/rust-lang/mdBook/pull/1122)
+- If you have a custom favicon, you may need to look into adding an SVG
+  version, otherwise the default SVG icon will be displayed.
+  [#1230](https://github.com/rust-lang/mdBook/pull/1230)
+
+### Added
+- Added a new `[rust]` configuration section to `book.toml`, which allows
+  setting the default edition with `edition = "2018"`.
+  [#1163](https://github.com/rust-lang/mdBook/pull/1163)
+- Renderers can now be marked as `optional`, so that they will be ignored if
+  the renderer is not installed.
+  [#1122](https://github.com/rust-lang/mdBook/pull/1122)
+- Added `head.hbs` to allow adding content to the `<head>` section in HTML.
+  [#1206](https://github.com/rust-lang/mdBook/pull/1206)
+- Added "draft chapters". These are chapters listed without a link to indicate
+  content yet to be written.
+  [#1153](https://github.com/rust-lang/mdBook/pull/1153)
+- Added "parts" to split a book into different sections. Headers can be added
+  to `SUMMARY.md` to signify different sections.
+  [#1171](https://github.com/rust-lang/mdBook/pull/1171)
+- Added generation of a "404" page for handling missing pages and broken links.
+  [#1221](https://github.com/rust-lang/mdBook/pull/1221)
+- Added configuration section for specifying URL redirects.
+  [#1237](https://github.com/rust-lang/mdBook/pull/1237)
+- Added an SVG favicon that works with light and dark colors schemes.
+  [#1230](https://github.com/rust-lang/mdBook/pull/1230)
+
+### Changed
+- Changed default Rust attribute of `allow(unused_variables)` to `allow(unused)`.
+  [#1195](https://github.com/rust-lang/mdBook/pull/1195)
+- Fonts are now served locally instead of from the Google Fonts CDN. The
+  `copy-fonts` option was added to disable this if you want to supply your own
+  fonts.
+  [#1188](https://github.com/rust-lang/mdBook/pull/1188)
+- Switched the built-in webserver for the `serve` command to a new
+  implementation. This results in some internal differences in how websockets
+  are handled, which removes the separate websocket options. This should also
+  make it easier to serve multiple books at once.
+  [#1211](https://github.com/rust-lang/mdBook/pull/1211)
+- The default dark theme is now "navy".
+  [#1199](https://github.com/rust-lang/mdBook/pull/1199)
+- "Playpen" has been renamed to "playground", matching the actual name of the
+  service which was renamed many years ago.
+  [#1241](https://github.com/rust-lang/mdBook/pull/1241)
+
+### Fixed
+- Links with the `+` symbol should now work.
+  [#1208](https://github.com/rust-lang/mdBook/pull/1208)
+- The `MDBOOK_BOOK` environment variable now correctly allows overriding the
+  entire book configuration.
+  [#1207](https://github.com/rust-lang/mdBook/pull/1207)
+- The sidebar can no longer be dragged outside of the window.
+  [#1229](https://github.com/rust-lang/mdBook/pull/1229)
+- Hide the Rust Playground "play" button for `no_run` code samples.
+  [#1249](https://github.com/rust-lang/mdBook/pull/1249)
+- Fixed the `--dest-dir` command-line option for the `serve` and `watch`
+  commands.
+  [#1228](https://github.com/rust-lang/mdBook/pull/1228)
+- Hotkey handlers are now disabled in `text` input fields (for example, typing
+  `S` in a custom text input field).
+  [#1244](https://github.com/rust-lang/mdBook/pull/1244)
+
+## mdBook 0.3.7
+[88684d8...99ecd4f](https://github.com/rust-lang/mdBook/compare/88684d8...99ecd4f)
+
+### Changed
+- Code spans in headers are no longer highlighted as code.
+  [#1162](https://github.com/rust-lang/mdBook/pull/1162)
+- The sidebar will now scroll the activate page to the middle instead of the top.
+  [#1161](https://github.com/rust-lang/mdBook/pull/1161)
+- Reverted change to reject build output within the `src` directory, and
+  instead add a check that prevents infinite copies.
+  [#1181](https://github.com/rust-lang/mdBook/pull/1181)
+  [#1026](https://github.com/rust-lang/mdBook/pull/1026)
+
+### Fixed
+- Fixed sidebar line-height jumping for collapsed chapters.
+  [#1182](https://github.com/rust-lang/mdBook/pull/1182)
+- Fixed theme selector focus.
+  [#1170](https://github.com/rust-lang/mdBook/pull/1170)
+
+## mdBook 0.3.6
+[efdb832...88684d8](https://github.com/rust-lang/mdBook/compare/efdb832...88684d8)
+
+### Added
+- `MDBook::execute_build_process` is now publicly accessible in the API so
+  that plugins can more easily initiate the build process.
+  [#1099](https://github.com/rust-lang/mdBook/pull/1099)
+
+### Changed
+- Use a different color for Ayu theme's highlighting for Rust attributes (uses
+  a bright color instead of the comment color).
+  [#1133](https://github.com/rust-lang/mdBook/pull/1133)
+- Adjusted spacing of sidebar entries.
+  [#1137](https://github.com/rust-lang/mdBook/pull/1137)
+- Slightly adjusted line-height of `<p>`, `<ul>`, and `<ol>`.
+  [#1136](https://github.com/rust-lang/mdBook/pull/1136)
+- Handlebars updated to 3.0.
+  [#1130](https://github.com/rust-lang/mdBook/pull/1130)
+
+### Fixed
+- Fix an issue with sidebar scroll position on reload.
+  [#1108](https://github.com/rust-lang/mdBook/pull/1108)
+- `mdbook serve` will retain the current scroll position when the page is reloaded.
+  [#1097](https://github.com/rust-lang/mdBook/pull/1097)
+- Fixed the page name if the book didn't have a title to not be prefixed with ` - `.
+  [#1145](https://github.com/rust-lang/mdBook/pull/1145)
+- HTML attributes `rel=next` and `rel=previous` are now supported in "wide"
+  mode (previously they were only set in narrow mode).
+  [#1150](https://github.com/rust-lang/mdBook/pull/1150)
+- Prevent recursive copies when the destination directory is contained in the
+  source directory.
+  [#1135](https://github.com/rust-lang/mdBook/pull/1135)
+- Adjusted the menu bar animation to not immediately obscure the top content.
+  [#989](https://github.com/rust-lang/mdBook/pull/989)
+- Fix for comments in SUMMARY.md that appear between items.
+  [#1167](https://github.com/rust-lang/mdBook/pull/1167)
+
+## mdBook 0.3.5
+[6e0d0fa...efdb832](https://github.com/rust-lang/mdBook/compare/6e0d0fa...efdb832)
+
+### Changed
+- The `default-theme` config setting is now case-insensitive.
+  [#1079](https://github.com/rust-lang/mdBook/pull/1079)
+
+### Fixed
+- Fixed `#` hidden Rust code lines not rendering properly.
+  [#1088](https://github.com/rust-lang/mdBook/pull/1088)
+- Updated pulldown-cmark to 0.6.1, fixing several issues.
+  [#1021](https://github.com/rust-lang/mdBook/pull/1021)
+
+## mdBook 0.3.4
+[e5f77aa...6e0d0fa](https://github.com/rust-lang/mdBook/compare/e5f77aa...6e0d0fa)
+
+### Changed
+- Switch to relative `rem` font sizes from `px`.
+  [#894](https://github.com/rust-lang/mdBook/pull/894)
+- Migrated repository to https://github.com/rust-lang/mdBook/
+  [#1083](https://github.com/rust-lang/mdBook/pull/1083)
+
+## mdBook 0.3.3
+[2b649fe...e5f77aa](https://github.com/rust-lang/mdBook/compare/2b649fe...e5f77aa)
+
+### Changed
+- Improvements to the automatic dark theme selection.
+  [#1069](https://github.com/rust-lang/mdBook/pull/1069)
+- Fragment links now prevent scrolling the header behind the menu bar.
+  [#1077](https://github.com/rust-lang/mdBook/pull/1077)
+
+### Fixed
+- Fixed error when building a book that has a spacer immediately after the
+  first chapter.
+  [#1075](https://github.com/rust-lang/mdBook/pull/1075)
+
+## mdBook 0.3.2
+[9cd47eb...2b649fe](https://github.com/rust-lang/mdBook/compare/9cd47eb...2b649fe)
+
+### Added
+- Added a markdown renderer, which is off by default. This may be useful for
+  debugging preprocessors.
+  [#1018](https://github.com/rust-lang/mdBook/pull/1018)
+- Code samples may now include line numbers with the
+  `output.html.playpen.line-numbers` configuration value.
+  [#1035](https://github.com/rust-lang/mdBook/pull/1035)
+- The `watch` and `serve` commands will now ignore files listed in
+  `.gitignore`.
+  [#1044](https://github.com/rust-lang/mdBook/pull/1044)
+- Added automatic dark-theme detection based on the CSS `prefers-color-scheme`
+  feature. This may be enabled by setting `output.html.preferred-dark-theme`
+  to your preferred dark theme.
+  [#1037](https://github.com/rust-lang/mdBook/pull/1037)
+- Added `rustdoc_include` preprocessor. This makes it easier to include
+  portions of an external Rust source file. The rest of the file is hidden,
+  but the user may expand it to see the entire file, and will continue to work
+  with `mdbook test`.
+  [#1003](https://github.com/rust-lang/mdBook/pull/1003)
+- Added Ctrl-Enter shortcut to the playpen editor to automatically run the
+  sample.
+  [#1066](https://github.com/rust-lang/mdBook/pull/1066)
+- Added `output.html.playpen.copyable` configuration option to disable
+  the copy button.
+  [#1050](https://github.com/rust-lang/mdBook/pull/1050)
+- Added ability to dynamically expand and fold sections within the sidebar.
+  See the `output.html.fold` configuration to enable this feature.
+  [#1027](https://github.com/rust-lang/mdBook/pull/1027)
+
+### Changed
+- Use standard `scrollbar-color` CSS along with webkit extension
+  [#816](https://github.com/rust-lang/mdBook/pull/816)
+- The renderer build directory is no longer deleted before the renderer is
+  run. This allows a backend to cache results between runs.
+  [#985](https://github.com/rust-lang/mdBook/pull/985)
+- Next/prev links now highlight on hover to indicate it is clickable.
+  [#994](https://github.com/rust-lang/mdBook/pull/994)
+- Increase padding of table headers.
+  [#824](https://github.com/rust-lang/mdBook/pull/824)
+- Errors in `[output.html]` config are no longer ignored.
+  [#1033](https://github.com/rust-lang/mdBook/pull/1033)
+- Updated highlight.js for syntax highlighting updates (primarily to add
+  async/await to Rust highlighting).
+  [#1041](https://github.com/rust-lang/mdBook/pull/1041)
+- Raised minimum supported rust version to 1.35.
+  [#1003](https://github.com/rust-lang/mdBook/pull/1003)
+- Hidden code lines are no longer dynamically removed via JavaScript, but
+  instead managed with CSS.
+  [#846](https://github.com/rust-lang/mdBook/pull/846)
+  [#1065](https://github.com/rust-lang/mdBook/pull/1065)
+- Changed the default font set for the ACE editor, giving preference to
+  "Source Code Pro".
+  [#1062](https://github.com/rust-lang/mdBook/pull/1062)
+- Windows 32-bit releases are no longer published.
+  [#1071](https://github.com/rust-lang/mdBook/pull/1071)
+
+### Fixed
+- Fixed sidebar auto-scrolling.
+  [#1052](https://github.com/rust-lang/mdBook/pull/1052)
+- Fixed error message when running `clean` multiple times.
+  [#1055](https://github.com/rust-lang/mdBook/pull/1055)
+- Actually fix the "next" link on index.html. The previous fix didn't work.
+  [#1005](https://github.com/rust-lang/mdBook/pull/1005)
+- Stop using `inline-block` for `inline code`, fixing selection highlighting
+  and some rendering issues.
+  [#1058](https://github.com/rust-lang/mdBook/pull/1058)
+- Fix header auto-hide on browsers with momentum scrolling that allows
+  negative `scrollTop`.
+  [#1070](https://github.com/rust-lang/mdBook/pull/1070)
+
+## mdBook 0.3.1
+[69a08ef...9cd47eb](https://github.com/rust-lang/mdBook/compare/69a08ef...9cd47eb)
+
+### Added
+- 🔥 Added ability to include files using anchor points instead of line numbers.
+  [#851](https://github.com/rust-lang/mdBook/pull/851)
+- Added `language` configuration value to set the language of the book, which
+  will affect things like the `<html lang="en">` tag.
+  [#941](https://github.com/rust-lang/mdBook/pull/941)
+
+### Changed
+- Updated to handlebars 2.0.
+  [#977](https://github.com/rust-lang/mdBook/pull/977)
+
+### Fixed
+- Fixed memory leak warning.
+  [#967](https://github.com/rust-lang/mdBook/pull/967)
+- Fix more print.html links.
+  [#963](https://github.com/rust-lang/mdBook/pull/963)
+- Fixed crash on some unicode input.
+  [#978](https://github.com/rust-lang/mdBook/pull/978)
+
+## mdBook 0.3.0
+[6cbc41d...69a08ef](https://github.com/rust-lang/mdBook/compare/6cbc41d...69a08ef)
+
+### Added
+- Added ability to resize the sidebar.
+  [#849](https://github.com/rust-lang/mdBook/pull/849)
+- Added `load_with_config_and_summary` function to `MDBook` to be able to
+  build a book with a custom `Summary`.
+  [#883](https://github.com/rust-lang/mdBook/pull/883)
+- Set `noindex` on `print.html` page to prevent robots from indexing it.
+  [#844](https://github.com/rust-lang/mdBook/pull/844)
+- Added support for ~~strikethrough~~ and GitHub-style tasklists.
+  [#952](https://github.com/rust-lang/mdBook/pull/952)
+
+### Changed
+- Command-line help output is now colored.
+  [#861](https://github.com/rust-lang/mdBook/pull/861)
+- The build directory is now deleted before rendering starts, instead of after
+  if finishes.
+  [#878](https://github.com/rust-lang/mdBook/pull/878)
+- Removed dependency on `same-file` crate.
+  [#903](https://github.com/rust-lang/mdBook/pull/903)
+- 💥 Renamed `with_preprecessor` to `with_preprocessor`.
+  [#906](https://github.com/rust-lang/mdBook/pull/906)
+- Updated ACE editor to 1.4.4, should remove a JavaScript console warning.
+  [#935](https://github.com/rust-lang/mdBook/pull/935)
+- Dependencies have been updated.
+  [#934](https://github.com/rust-lang/mdBook/pull/934)
+  [#945](https://github.com/rust-lang/mdBook/pull/945)
+- Highlight.js has been updated. This fixes some TOML highlighting, and adds
+  Julia support.
+  [#942](https://github.com/rust-lang/mdBook/pull/942)
+- 🔥 Updated to pulldown-cmark 0.5. This may have significant changes to the
+  formatting of existing books, as the newer version has more accurate
+  interpretation of the CommonMark spec and a large number of bug fixes and
+  changes.
+  [#898](https://github.com/rust-lang/mdBook/pull/898)
+- The `diff` language should now highlight correctly.
+  [#943](https://github.com/rust-lang/mdBook/pull/943)
+- Make the blank region of a header not clickable.
+  [#948](https://github.com/rust-lang/mdBook/pull/948)
+- Rustdoc tests now use the preprocessed content instead of the raw,
+  unpreprocessed content.
+  [#891](https://github.com/rust-lang/mdBook/pull/891)
+
+### Fixed
+- Fixed file change detection so that `mdbook serve` only reloads once when
+  multiple files are changed at once.
+  [#870](https://github.com/rust-lang/mdBook/pull/870)
+- Fixed on-hover color highlighting for links in sidebar.
+  [#834](https://github.com/rust-lang/mdBook/pull/834)
+- Fixed loss of focus when clicking the "Copy" button in code blocks.
+  [#867](https://github.com/rust-lang/mdBook/pull/867)
+- Fixed incorrectly stripping the path for `additional-js` files.
+  [#796](https://github.com/rust-lang/mdBook/pull/796)
+- Fixed color of `code spans` that are links.
+  [#905](https://github.com/rust-lang/mdBook/pull/905)
+- Fixed "next" navigation on index.html.
+  [#916](https://github.com/rust-lang/mdBook/pull/916)
+- Fixed keyboard chapter navigation for `file` urls.
+  [#915](https://github.com/rust-lang/mdBook/pull/915)
+- Fixed bad wrapping for inline code on some browsers.
+  [#818](https://github.com/rust-lang/mdBook/pull/818)
+- Properly load an existing `SUMMARY.md` in `mdbook init`.
+  [#841](https://github.com/rust-lang/mdBook/pull/841)
+- Fixed some broken links in `print.html`.
+  [#871](https://github.com/rust-lang/mdBook/pull/871)
+- The Rust Playground link now supports the 2018 edition.
+  [#946](https://github.com/rust-lang/mdBook/pull/946)
+
+## mdBook 0.2.3 (2018-01-18)
+[2c20c99...6cbc41d](https://github.com/rust-lang/mdBook/compare/2c20c99...6cbc41d)
+
+### Added
+- Added an optional button to the top of the page which will link to a git
+  repository. Use the `git-repository-url` and `git-repository-icon` options
+  in the `[output.html]` section to enable it and set its appearance.
+  [#802](https://github.com/rust-lang/mdBook/pull/802)
+- Added a `default-theme` option to the `[output.html]` section.
+  [#804](https://github.com/rust-lang/mdBook/pull/804)
+
+### Changed
+- 💥 Header ID anchors no longer add an arbitrary `a` character for headers
+  that start with a non-ascii-alphabetic character.
+  [#788](https://github.com/rust-lang/mdBook/pull/788)
+
+### Fixed
+- Fix websocket hostname usage
+  [#865](https://github.com/rust-lang/mdBook/pull/865)
+- Fixing links in print.html
+  [#866](https://github.com/rust-lang/mdBook/pull/866)
+
+## mdBook 0.2.2 (2018-10-19)
+[7e2e095...2c20c99](https://github.com/rust-lang/mdBook/compare/7e2e095...2c20c99)
+
+### Added
+- 🎉 Process-based custom preprocessors. See [the
+  docs](https://rust-lang.github.io/mdBook/for_developers/preprocessors.html)
+  for more.
+  [#792](https://github.com/rust-lang/mdBook/pull/792)
+
+- 🎉 Configurable preprocessors.
+
+  Added `build.use-default-preprocessors` boolean TOML key to allow disabling
+  the built-in `links` and `index` preprocessors.
+
+  Added `[preprocessor]` TOML tables to configure each preprocessor.
+
+  Specifying `[preprocessor.links]` or `[preprocessor.index]` will enable the
+  respective built-in preprocessor if `build.use-default-preprocessors` is
+  `false`.
+
+  Added `fn supports_renderer(&self, renderer: &str) -> bool` to the
+  `Preprocessor` trait to specify if the preprocessor supports the given
+  renderer. The default implementation always returns `true`.
+
+  `Preprocessor::run` now takes a book by value instead of a mutable
+  reference. It should return a `Book` value with the intended modifications.
+
+  Added `PreprocessorContext::renderer` to indicate the renderer being used.
+
+  [#658](https://github.com/rust-lang/mdBook/pull/658)
+  [#787](https://github.com/rust-lang/mdBook/pull/787)
+
+### Fixed
+- Fix paths to additional CSS and JavaScript files
+  [#777](https://github.com/rust-lang/mdBook/pull/777)
+- Ensure section numbers are correctly incremented after a horizontal
+  separator
+  [#790](https://github.com/rust-lang/mdBook/pull/790)
+
+## mdBook 0.2.1 (2018-08-22)
+[91ffca1...7e2e095](https://github.com/rust-lang/mdBook/compare/91ffca1...7e2e095)
+
+### Changed
+- Update to handlebars-rs 1.0
+  [#761](https://github.com/rust-lang/mdBook/pull/761)
+
+### Fixed
+- Fix table colors, broken by Stylus -> CSS transition
+  [#765](https://github.com/rust-lang/mdBook/pull/765)
+
+## mdBook 0.2.0 (2018-08-02)
+
+### Changed
+- 💥 This release changes how links are handled in mdBook. Previously, relative
+  links were interpreted relative to the book's root. In `0.2.0`+ links are
+  relative to the page they are in, and use the `.md` extension. This has [several
+  advantages](https://github.com/rust-lang/mdBook/pull/603#issue-166701447),
+  such as making links work in other markdown viewers like GitHub. You will
+  likely have to change links in your book to accommodate this change. For
+  example, a book with this layout:
+
+  ```
+  chapter_1/
+      section_1.md
+      section_2.md
+  SUMMARY.md
+  ```
+
+  Previously a link in `section_1.md` to `section_2.md` would look like this:
+  ```markdown
+  [section_2](chapter_1/section_2.html)
+  ```
+
+  Now it must be changed to this:
+  ```markdown
+  [section_2](section_2.md)
+  ```
+
+- 💥 `mdbook test --library-path` now accepts a comma-delimited list of
+  arguments rather than taking all following arguments. This makes it easier
+  to handle the trailing book directory argument without always needing to put
+  ` -- ` before it. Multiple instances of the option continue to be accepted:
+  `mdbook test -L foo -L bar`.
+
+- 💥 `mdbook serve` has some of its options renamed for clarity. See `mdbook
+  help serve` for details.
+
+- Embedded rust playpens now use the "stable" playground API.
+  [#754](https://github.com/rust-lang/mdBook/pull/754)
+
+### Fixed
+- Escaped includes (`\{{#include file.rs}}`) will now render correctly.
+  [f30ce01](https://github.com/rust-lang/mdBook/commit/f30ce0184d71e342141145472bf816419d30a2c5)
+- `index.html` will now render correctly when the book's first section is
+  inside a subdirectory.
+  [#756](https://github.com/rust-lang/mdBook/pull/756)

CONTRIBUTING.md

@@ -0,0 +1,108 @@
+# Contributing
+
+Welcome stranger!
+
+If you have come here to learn how to contribute to mdBook, we have some tips for you!
+
+First of all, don't hesitate to ask questions!
+Use the [issue tracker](https://github.com/rust-lang/mdBook/issues), no question is too simple.
+If we don't respond in a couple of days, ping us @Michael-F-Bryan, @budziq, @steveklabnik, @frewsxcv it might just be that we forgot. :wink:
+
+### Issues to work on
+
+Any issue is up for the grabbing, but if you are starting out, you might be interested in the
+[E-Easy issues](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
+Those are issues that are considered more straightforward for beginners to Rust or the codebase itself.
+These issues can be a good launching pad for more involved issues. Easy tasks for a first time contribution
+include documentation improvements, new tests, examples, updating dependencies, etc.
+
+If you come from a web development background, you might be interested in issues related to web technologies tagged
+[A-JavaScript](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
+[A-Style](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
+[A-HTML](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-HTML) or
+[A-Mobile](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Mobile).
+
+When you decide you want to work on a specific issue, ping us on that issue so that we can assign it to you.
+Again, do not hesitate to ask questions. We will gladly mentor anyone that want to tackle an issue.
+
+Issues on the issue tracker are categorized with the following labels:
+
+- **A**-prefixed labels state which area of the project an issue relates to.
+- **E**-prefixed labels show an estimate of the experience necessary to fix the issue.
+- **M**-prefixed labels are meta-issues used for questions, discussions, or tracking issues
+- **S**-prefixed labels show the status of the issue
+- **T**-prefixed labels show the type of issue
+
+### Building mdBook
+
+mdBook builds on stable Rust, if you want to build mdBook from source, here are the steps to follow:
+
+1. Navigate to the directory of your choice
+0. Clone this repository with git.
+
+   ```
+   git clone https://github.com/rust-lang/mdBook.git
+   ```
+0. Navigate into the newly created `mdBook` directory
+0. Run `cargo build`
+
+The resulting binary can be found in `mdBook/target/debug/` under the name `mdBook` or `mdBook.exe`.
+
+### Code Quality
+
+We love code quality and Rust has some excellent tools to assist you with contributions.
+
+#### Formatting Code with rustfmt
+
+Before you make your Pull Request to the project, please run it through the `rustfmt` utility.
+This will ensure we have good quality source code that is better for us all to maintain.
+
+[rustfmt](https://github.com/rust-lang/rustfmt) has a lot more information on the project.
+The quick guide is
+
+1. Install it
+    ```
+    rustup component add rustfmt
+    ```
+1. You can now run `rustfmt` on a single file simply by...
+    ```
+    rustfmt src/path/to/your/file.rs
+    ```
+   ... or you can format the entire project with
+   ```
+   cargo fmt
+   ```
+   When run through `cargo` it will format all bin and lib files in the current crate.
+
+For more information, such as running it from your favourite editor, please see the `rustfmt` project. [rustfmt](https://github.com/rust-lang/rustfmt)
+
+
+#### Finding Issues with Clippy
+
+Clippy is a code analyser/linter detecting mistakes, and therfore helps to improve your code.
+Like formatting your code with `rustfmt`, running clippy regularly and before your Pull Request will
+help us maintain awesome code.
+
+The best documentation can be found over at [rust-clippy](https://github.com/rust-lang/rust-clippy)
+
+1. To install
+    ```
+    rustup component add clippy
+    ```
+2. Running clippy
+    ```
+    cargo clippy
+    ```
+
+Clippy has an ever growing list of checks, that are managed in [lint files](https://rust-lang.github.io/rust-clippy/master/index.html).
+
+### Making a pull-request
+
+When you feel comfortable that your changes could be integrated into mdBook, you can create a pull-request on GitHub.
+One of the core maintainers will then approve the changes or request some changes before it gets merged.
+
+If you want to make your pull-request even better, you might want to run [Clippy](https://github.com/Manishearth/rust-clippy)
+and [rustfmt](https://github.com/rust-lang/rustfmt) on the code first.
+This is not a requirement though and will never block a pull-request from being merged.
+
+That's it, happy contributions! :tada: :tada: :tada:

Cargo.toml

@@ -1,54 +1,63 @@
 [package]
 name = "mdbook"
-version = "0.0.21"
-authors = ["Mathieu David <mathieudavid@mathieudavid.org>"]
-description = "create books from markdown files (like Gitbook)"
-documentation = "http://azerupi.github.io/mdBook/index.html"
-repository = "https://github.com/azerupi/mdBook"
+version = "0.4.4"
+authors = [
+    "Mathieu David <mathieudavid@mathieudavid.org>",
+    "Michael-F-Bryan <michaelfbryan@gmail.com>",
+    "Matt Ickstadt <mattico8@gmail.com>"
+]
+documentation = "http://rust-lang.github.io/mdBook/index.html"
+edition = "2018"
+exclude = ["/guide/*"]
 keywords = ["book", "gitbook", "rustbook", "markdown"]
 license = "MPL-2.0"
 readme = "README.md"
-build = "build.rs"
-exclude = [
-    "book-example/*",
-    "src/theme/stylus",
-]
+repository = "https://github.com/rust-lang/mdBook"
+description = "Creates a book from markdown files"
 
 [dependencies]
-clap = "2.19.2"
-handlebars = { version = "0.25.0", features = ["serde_type"] }
-serde = "0.9"
-serde_json = "0.9"
-pulldown-cmark = "0.0.8"
-log = "0.3"
-env_logger = "0.4.0"
-toml = { version = "0.3", features = ["serde"] }
+anyhow = "1.0.28"
+chrono = "0.4"
+clap = "2.24"
+env_logger = "0.7.1"
+handlebars = "3.0"
+lazy_static = "1.0"
+log = "0.4"
+memchr = "2.0"
 open = "1.1"
-regex = "0.2.1"
+pulldown-cmark = "0.7.0"
+regex = "1.0.0"
+serde = "1.0"
+serde_derive = "1.0"
+serde_json = "1.0"
+shlex = "0.1"
+tempfile = "3.0"
+toml = "0.5.1"
 
 # Watch feature
 notify = { version = "4.0", optional = true }
-time = { version = "0.1.34", optional = true }
-crossbeam = { version = "0.2.8", optional = true }
+gitignore = { version = "1.0", optional = true }
 
 # Serve feature
-iron = { version = "0.5", optional = true }
-staticfile = { version = "0.4", optional = true }
-ws = { version = "0.6", optional = true}
+futures-util = { version = "0.3.4", optional = true }
+tokio = { version = "0.2.18", features = ["macros"], optional = true }
+warp = { version = "0.2.2", default-features = false, features = ["websocket"], optional = true }
+
+# Search feature
+elasticlunr-rs = { version = "2.3", optional = true, default-features = false }
+ammonia = { version = "3", optional = true }
 
-# Tests
 [dev-dependencies]
-tempdir = "0.3.4"
+select = "0.5"
+pretty_assertions = "0.6"
+walkdir = "2.0"
 
 [features]
-default = ["output", "watch", "serve"]
-debug = []
-output = []
-regenerate-css = []
-watch = ["notify", "time", "crossbeam"]
-serve = ["iron", "staticfile", "ws"]
+default = ["watch", "serve", "search"]
+watch = ["notify", "gitignore"]
+serve = ["futures-util", "tokio", "warp"]
+search = ["elasticlunr-rs", "ammonia"]
 
 [[bin]]
 doc = false
 name = "mdbook"
-path = "src/bin/mdbook.rs"

README.md

@@ -1,84 +1,100 @@
 # mdBook
 
-<table>
-    <tr>
-        <td><strong>Linux / OS X</strong></td>
-        <td>
-            <a href="https://travis-ci.org/azerupi/mdBook"><img src="https://travis-ci.org/azerupi/mdBook.svg?branch=master"></a>
-        </td>
-    </tr>
-    <tr>
-        <td><strong>Windows</strong></td>
-        <td>
-            <a href="https://ci.appveyor.com/project/azerupi/mdbook/"><img src="https://ci.appveyor.com/api/projects/status/o38racsnbcospyc8/branch/master?svg=true"></a>
-        </td>
-    </tr>
-    <tr>
-        <td colspan="2">
-            <a href="https://crates.io/crates/mdbook"><img src="https://img.shields.io/crates/v/mdbook.svg"></a>
-            <a href="LICENSE"><img src="https://img.shields.io/crates/l/mdbook.svg"></a>
-        </td>
-    </tr>
-</table>
+[![Build Status](https://github.com/rust-lang/mdBook/workflows/CI/badge.svg?event=push)](https://github.com/rust-lang/mdBook/actions?workflow=CI)
+[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook)
+[![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE)
 
 mdBook is a utility to create modern online books from Markdown files.
 
-**This project is still evolving.**  
-See [#90](https://github.com/azerupi/mdBook/issues/90)
-
 
 ## What does it look like?
 
-The [**Documentation**](http://azerupi.github.io/mdBook/) for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.
+The [User Guide] for mdBook has been written in Markdown and is using mdBook to
+generate the online book-like website you can read. The documentation uses the
+latest version on GitHub and showcases the available features.
 
 ## Installation
 
 There are multiple ways to install mdBook.
 
-1. **Binaries**  
-   Binaries are available for download [here](https://github.com/azerupi/mdBook/releases). Make sure to put the path to the binary into your `PATH`.
+1. **Binaries**
+
+   Binaries are available for download [here][releases]. Make sure to put the
+   path to the binary into your `PATH`.
+
+2. **From Crates.io**
+
+   This requires at least [Rust] 1.39 and Cargo to be installed. Once you have installed
+   Rust, type the following in the terminal:
 
-2. **From Crates.io**  
-   This requires [Rust and Cargo](https://www.rust-lang.org/) to be installed. Once you have installed Rust, type the following in the terminal:
    ```
    cargo install mdbook
    ```
 
-   This will download and compile mdBook for you, the only thing left to do is to add the Cargo bin directory to your `PATH`.
+   This will download and compile mdBook for you, the only thing left to do is
+   to add the Cargo bin directory to your `PATH`.
 
-3. **From Git**  
-   The version published to crates.io will ever so slightly be behind the version hosted here on GitHub. If you need the latest version you can build the git version of mdBook yourself. Cargo makes this ***super easy***!
+   **Note for automatic deployment**
+
+   If you are using a script to do automatic deployments using Travis or
+   another CI server, we recommend that you specify a semver version range for
+   mdBook when you install it through your script!
+
+   This will constrain the server to install the latest **non-breaking**
+   version of mdBook and will prevent your books from failing to build because
+   we released a new version.
+
+   You can also disable default features to speed up compile time.
+
+   Example:
 
    ```
-   cargo install --git https://github.com/azerupi/mdBook.git
+   cargo install mdbook --no-default-features --features output --vers "^0.1.0"
    ```
+
+3. **From Git**
+
+   The version published to crates.io will ever so slightly be behind the
+   version hosted here on GitHub. If you need the latest version you can build
+   the git version of mdBook yourself. Cargo makes this ***super easy***!
+
+   ```
+   cargo install --git https://github.com/rust-lang/mdBook.git mdbook
+   ```
+
    Again, make sure to add the Cargo bin directory to your `PATH`.
 
-4. **For Contributions**  
-   If you want to contribute to mdBook you will have to clone the repository on your local machine:
+4. **For Contributions**
+
+   If you want to contribute to mdBook you will have to clone the repository on
+   your local machine:
 
    ```
-   git clone https://github.com/azerupi/mdBook.git
+   git clone https://github.com/rust-lang/mdBook.git
    ```
+
    `cd` into `mdBook/` and run
 
    ```
    cargo build
    ```
 
-   The resulting binary can be found in `mdBook/target/debug/` under the name `mdBook` or `mdBook.exe`.
-
+   The resulting binary can be found in `mdBook/target/debug/` under the name
+   `mdBook` or `mdBook.exe`.
 
 
 ## Usage
 
-mdBook will primarily be used as a command line tool, even though it exposes all its functionality as a Rust crate for integration in other projects.
+mdBook is primarily used as a command line tool, even though it exposes
+all its functionality as a Rust crate for integration in other projects.
 
-Here are the main commands you will want to run. For a more exhaustive explanation, check out the [documentation](http://azerupi.github.io/mdBook/).
+Here are the main commands you will want to run. For a more exhaustive
+explanation, check out the [User Guide].
 
 - `mdbook init`
 
-    The init command will create a directory with the minimal boilerplate to start with.
+    The init command will create a directory with the minimal boilerplate to
+    start with.
 
     ```
     book-test/
@@ -88,39 +104,131 @@ Here are the main commands you will want to run. For a more exhaustive explanati
         └── SUMMARY.md
     ```
 
-    `book` and `src` are both directories. `src` contains the markdown files that will be used to render the output to the `book` directory.
+    `book` and `src` are both directories. `src` contains the markdown files
+    that will be used to render the output to the `book` directory.
 
-    Please, take a look at the [**Documentation**](http://azerupi.github.io/mdBook/cli/init.html) for more information and some neat tricks.
+    Please, take a look at the [CLI docs] for more information and some neat tricks.
 
 - `mdbook build`
 
-    This is the command you will run to render your book, it reads the `SUMMARY.md` file to understand the structure of your book, takes the markdown files in the source directory as input and outputs static html pages that you can upload to a server.
+    This is the command you will run to render your book, it reads the
+    `SUMMARY.md` file to understand the structure of your book, takes the
+    markdown files in the source directory as input and outputs static html
+    pages that you can upload to a server.
 
 - `mdbook watch`
 
-    When you run this command, mdbook will watch your markdown files to rebuild the book on every change. This avoids having to come back to the terminal to type `mdbook build` over and over again.
+    When you run this command, mdbook will watch your markdown files to rebuild
+    the book on every change. This avoids having to come back to the terminal
+    to type `mdbook build` over and over again.
 
 - `mdbook serve`
 
-    Does the same thing as `mdbook watch` but additionally serves the book at `http://localhost:3000` (port is changeable) and reloads the browser when a change occurs.
+    Does the same thing as `mdbook watch` but additionally serves the book at
+    `http://localhost:3000` (port is changeable) and reloads the browser when a
+    change occurs.
+
+- `mdbook clean`
+
+    Delete directory in which generated book is located.
+
+### 3rd Party Plugins
+
+The way a book is loaded and rendered can be configured by the user via third
+party plugins. These plugins are just programs which will be invoked during the
+build process and are split into roughly two categories, *preprocessors* and
+*renderers*.
+
+Preprocessors are used to transform a book before it is sent to a renderer.
+One example would be to replace all occurrences of
+`{{#include some_file.ext}}` with the contents of that file. Some existing
+preprocessors are:
+
+- `index` - a built-in preprocessor (enabled by default) which will transform
+  all `README.md` chapters to `index.md` so `foo/README.md` can be accessed via
+  the url `foo/` when published to a browser
+- `links` - a built-in preprocessor (enabled by default) for expanding the
+  `{{# playground}}` and `{{# include}}` helpers in a chapter.
+
+Renderers are given the final book so they can do something with it. This is
+typically used for, as the name suggests, rendering the document in a particular
+format, however there's nothing stopping a renderer from doing static analysis
+of a book in order to validate links or run tests. Some existing renderers are:
+
+- `html` - the built-in renderer which will generate a HTML version of the book
+- `markdown` - the built-in renderer (disabled by default) which will run
+  preprocessors then output the resulting Markdown. Useful for debugging
+  preprocessors.
+- [`linkcheck`] - a backend which will check that all links are valid
+- [`epub`] - an experimental EPUB generator
+
+> **Note for Developers:** Feel free to send us a PR if you've developed your
+> own plugin and want it mentioned here.
+
+A preprocessor or renderer is enabled by installing the appropriate program and
+then mentioning it in the book's `book.toml` file.
+
+```console
+$ cargo install mdbook-linkcheck
+$ edit book.toml && cat book.toml
+[book]
+title = "My Awesome Book"
+authors = ["Michael-F-Bryan"]
+
+[output.html]
+
+[output.linkcheck]  # enable the "mdbook-linkcheck" renderer
+
+$ mdbook build
+2018-10-20 13:57:51 [INFO] (mdbook::book): Book building has started
+2018-10-20 13:57:51 [INFO] (mdbook::book): Running the html backend
+2018-10-20 13:57:53 [INFO] (mdbook::book): Running the linkcheck backend
+```
+
+For more information on the plugin system, consult the [User Guide].
 
 ### As a library
 
-Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with an easy to use API and more!
+Aside from the command line interface, this crate can also be used as a
+library. This means that you could integrate it in an existing project, like a
+web-app for example. Since the command line interface is just a wrapper around
+the library functionality, when you use this crate as a library you have full
+access to all the functionality of the command line interface with an easy to
+use API and more!
 
-See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information.
+See the [User Guide] and the [API docs] for more information.
 
 ## Contributions
 
-Contributions are highly appreciated and encouraged! Don't hesitate to participate to discussions in the issues, propose new features and ask for help.
+Contributions are highly appreciated and encouraged! Don't hesitate to
+participate to discussions in the issues, propose new features and ask for
+help.
 
-If you are not very confident with Rust, **I will be glad to mentor as best as I can if you decide to tackle an issue or new feature.**
+If you are just starting out with Rust, there are a series of issues that are
+tagged [E-Easy] and **we will gladly mentor you** so that you can successfully
+go through the process of fixing a bug or adding a new feature! Let us know if
+you need any help.
 
-People who are not familiar with the code can look at [issues that are tagged **easy**](https://github.com/azerupi/mdBook/labels/Easy). A lot of issues are also related to web development, so people that are not comfortable with Rust can also participate! :wink:
+For more info about contributing, check out our [contribution guide] which helps
+you go through the build and contribution process!
 
-You can pick any issue you want to work on. Usually it's a good idea to ask if someone is already working on it and if not to claim the issue.
+There is also a [rendered version][master-docs] of the latest API docs
+available, for those hacking on `master`.
 
 
 ## License
 
-All the code is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE](LICENSE) file.
+All the code in this repository is released under the ***Mozilla Public License v2.0***, for more information take a look at the [LICENSE] file.
+
+
+[User Guide]: https://rust-lang.github.io/mdBook/
+[API docs]: https://docs.rs/mdbook/*/mdbook/
+[E-Easy]: https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy
+[contribution guide]: https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md
+[LICENSE]: https://github.com/rust-lang/mdBook/blob/master/LICENSE
+[releases]: https://github.com/rust-lang/mdBook/releases
+[Rust]: https://www.rust-lang.org/
+[CLI docs]: http://rust-lang.github.io/mdBook/cli/init.html
+[master-docs]: http://rust-lang.github.io/mdBook/
+[`linkcheck`]: https://crates.io/crates/mdbook-linkcheck
+[`epub`]: https://crates.io/crates/mdbook-epub

appveyor.yml

@@ -1,60 +0,0 @@
-environment:
-  global:
-    PROJECT_NAME: mdBook
-  matrix:
-    # Stable channel
-    - TARGET: i686-pc-windows-msvc
-      RUST_CHANNEL: stable
-    - TARGET: x86_64-pc-windows-msvc
-      RUST_CHANNEL: stable
-    # Beta channel
-    - TARGET: i686-pc-windows-msvc
-      RUST_CHANNEL: beta
-    - TARGET: x86_64-pc-windows-msvc
-      RUST_CHANNEL: beta
-    # Nightly channel
-    - TARGET: i686-pc-windows-msvc
-      RUST_CHANNEL: nightly
-    - TARGET: x86_64-pc-windows-msvc
-      RUST_CHANNEL: nightly
-
-# Install Rust and Cargo
-install:
-  - ps: Start-FileDownload "https://static.rust-lang.org/dist/channel-rust-stable"
-  - ps: $env:RUST_VERSION = Get-Content channel-rust-stable | select -first 1 | %{$_.split('-')[1]}
-  - if NOT "%RUST_CHANNEL%" == "stable" set RUST_VERSION=%RUST_CHANNEL%
-  - ps: Start-FileDownload "https://static.rust-lang.org/dist/rust-${env:RUST_VERSION}-${env:TARGET}.exe"
-  - rust-%RUST_VERSION%-%TARGET%.exe /VERYSILENT /NORESTART /DIR="C:\Program Files (x86)\Rust"
-  - SET PATH=%PATH%;C:\Program Files (x86)\Rust\bin
-  - rustc -V
-  - cargo -V
-
-build: false
-
-# Equivalent to Travis' `script` phase
-test_script:
-  - cargo build --verbose
-  - cargo test --verbose
-
-before_deploy:
-  # Generate artifacts for release
-  - cargo build --release
-  - mkdir staging
-  - copy target\release\mdbook.exe staging
-  - cd staging
-  - 7z a ../%PROJECT_NAME%-%APPVEYOR_REPO_TAG_NAME%-%TARGET%.zip *
-  - appveyor PushArtifact ../%PROJECT_NAME%-%APPVEYOR_REPO_TAG_NAME%-%TARGET%.zip
-
-deploy:
-  description: 'Windows release'
-  artifact: /.*\.zip/
-  auth_token:
-    secure: QQhjKVyz7mpjlyGhlXytbFQQfKFQWTahHkD+B0NzIUoEVqO7ZLWjnoWasvLqW4nE
-  provider: GitHub
-  on:
-    RUST_CHANNEL: stable
-    appveyor_repo_tag: true
-
-branches:
-  only:
-    - master

book-example/book.toml

@@ -1,3 +0,0 @@
-title = "mdBook Documentation"
-description = "Create book from markdown files. Like Gitbook but implemented in Rust"
-author = "Mathieu David"

book-example/src/README.md

@@ -1,16 +0,0 @@
-# mdBook
-
-**mdBook** is a command line tool and Rust crate to create books using Markdown files. It's very similar to Gitbook but written in [Rust](http://www.rust-lang.org).
-
-What you are reading serves as an example of the output of mdBook and at the same time as high-level docs.
-
-mdBook is free and open source, you can find the source code on [Github](https://github.com/azerupi/mdBook). Issues and feature requests can be posted on the [Github Issue tracker](https://github.com/azerupi/mdBook/issues).
-
-## API docs
-
-Alongside this book you can also read the [API docs](mdbook/index.html) generated by Rustdoc if you would like
-to use mdBook as a crate or write a new renderer and need a more low-level overview.
-
-## License
-
-mdBook, all the source code, is released under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/)

book-example/src/cli/build.md

@@ -1,35 +0,0 @@
-# The build command
-
-The build command is used to render your book:
-
-```bash
-mdbook build
-```
-
-It will try to parse your `SUMMARY.md` file to understand the structure of your book
-and fetch the corresponding files.
-
-The rendered output will maintain the same directory structure as the source for
-convenience. Large books will therefore remain structured when rendered.
-
-#### Specify a directory
-
-Like `init`, the `build` command can take a directory as argument to use instead of the
-current working directory.
-
-```bash
-mdbook build path/to/book
-```
-
-#### --open
-
-When you use the `--open` (`-o`) option, mdbook will open the rendered book in
-your default web browser after building it.
-
-#### --dest-dir
-
-The `--dest-dir` (`-d`) option allows you to change the output directory for your book.
-
--------------------
-
-***note:*** *make sure to run the build command in the root directory and not in the source directory*

book-example/src/cli/cli-tool.md

@@ -1,35 +0,0 @@
-# Command Line Tool
-
-mdBook can be used either as a command line tool or a [Rust crate](https://crates.io/crates/mdbook).
-Let's focus on the command line tool capabilities first.
-
-## Install
-
-### Pre-requisite
-
-mdBook is written in **[Rust](https://www.rust-lang.org/)** and therefore needs to be compiled with **Cargo**, because we don't yet offer ready-to-go binaries. If you haven't already installed Rust, please go ahead and [install it](https://www.rust-lang.org/downloads.html) now.
-
-### Install Crates.io version
-
-Installing mdBook is relatively easy if you already have Rust and Cargo installed. You just have to type this snippet in your terminal:
-
-```bash
-cargo install mdbook
-```
-
-This will fetch the source code from [Crates.io](https://crates.io/) and compile it. You will have to add Cargo's `bin` directory to your `PATH`.
-
-Run `mdbook help` in your terminal to verify if it works. Congratulations, you have installed mdBook!
-
-
-### Install Git version
-
-The **[git version](https://github.com/azerupi/mdBook)** contains all the latest bug-fixes and features, that will be released in the next version on **Crates.io**, if you can't wait until the next release. You can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.
-
-```bash
-git clone --depth=1 https://github.com/azerupi/mdBook.git
-cd mdBook
-cargo build --release
-```
-
-The executable `mdbook` will be in the `./target/release` folder, this should be added to the path.

book-example/src/cli/init.md

@@ -1,45 +0,0 @@
-# The init command
-There is some minimal boilerplate that is the same for every new book. It's for this purpose that mdBook includes an `init` command.
-
-The `init` command is used like this:
-
-```bash
-mdbook init
-```
-
-When using the `init` command for the first time, a couple of files will be set up for you:
-```bash
-book-test/
-├── book
-└── src
-    ├── chapter_1.md
-    └── SUMMARY.md
-```
-
-- The `src` directory is were you write your book in markdown. It contains all the source files,
-configuration files, etc.
-
-- The `book` directory is where your book is rendered. All the output is ready to be uploaded
-to a server to be seen by your audience.
-
-- The `SUMMARY.md` file is the most important file, it's the skeleton of your book and is discussed in more detail in another  [chapter](format/summary.html).
-
-#### Tip & Trick: Hidden Feature
-When a `SUMMARY.md` file already exists, the `init` command will first parse it and generate the missing files according to the paths used in the `SUMMARY.md`. This allows you to think and create the whole structure of your book and then let mdBook generate it for you.
-
-#### Specify a directory
-
-When using the `init` command, you can also specify a directory, instead of using the current working directory,
-by appending a path to the command:
-
-```bash
-mdbook init path/to/book
-```
-
-## --theme
-
-When you use the `--theme` argument, the default theme will be copied into a directory
-called `theme` in your source directory so that you can modify it.
-
-The theme is selectively overwritten, this means that if you don't want to overwrite a
-specific file, just delete it and the default file will be used.

book-example/src/cli/serve.md

@@ -1,40 +0,0 @@
-# The serve command
-
-The `serve` command is useful when you want to preview your book. It also does hot reloading of the webpage whenever a file changes.
-It achieves this by serving the books content over `localhost:3000` (unless otherwise configured, see below) and runs a websocket server on `localhost:3001` which triggers the reloads.
-This preferred by many for writing books with mdbook because it allows for you to see the result of your work instantly after every file change.
-
-#### Specify a directory
-
-Like `watch`, `serve` can take a directory as argument to use instead of the
-current working directory.
-
-```bash
-mdbook serve path/to/book
-```
-
-
-#### Server options
-
-`serve` has four options: the http port, the websocket port, the interface to serve on, and the public address of the server so that the browser may reach the websocket server.
-
-For example: suppose you had an nginx server for SSL termination which has a public address of 192.168.1.100 on port 80 and proxied that to 127.0.0.1 on port 8000. To run use the nginx proxy do:
-
-```bash
-mdbook server path/to/book -p 8000 -i 127.0.0.1 -a 192.168.1.100
-```
-
-If you were to want live reloading for this you would need to proxy the websocket calls through nginx as well from `192.168.1.100:<WS_PORT>` to `127.0.0.1:<WS_PORT>`. The `-w` flag allows for the websocket port to be configured.
-
-#### --open
-
-When you use the `--open` (`-o`) option, mdbook will open the book in your
-your default web browser after starting the server.
-
-#### --dest-dir
-
-The `--dest-dir` (`-d`) option allows you to change the output directory for your book.
-
------
-
-***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*

book-example/src/cli/test.md

@@ -1,19 +0,0 @@
-# The test command
-
-When writing a book, you sometimes need to automate some tests. For example, [The Rust Programming Book](https://doc.rust-lang.org/stable/book/) uses a lot of code examples that could get outdated.
-Therefore it is very important for them to be able to automatically test these code examples.
-
-mdBook supports a `test` command that will run all available tests in mdBook. At the moment, only one test is available:
-*"Test Rust code examples using Rustdoc"*, but I hope this will be expanded in the future to include more tests like:
-
-- checking for broken links
-- checking for unused files
-- ...
-
-In the future I would like the user to be able to enable / disable test from the `book.toml` configuration file and support custom tests.
-
-**How to use it:**
-```bash
-$ mdbook test
-[*]: Testing file: "/mdBook/book-example/src/README.md”
-```

book-example/src/cli/watch.md

@@ -1,26 +0,0 @@
-# The watch command
-
-The `watch` command is useful when you want your book to be rendered on every file change.
-You could repeatedly issue `mdbook build` every time a file is changed. But using `mdbook watch` once will watch your files and will trigger a build automatically whenever you modify a file.
-
-#### Specify a directory
-
-Like `init` and `build`, `watch` can take a directory as argument to use instead of the
-current working directory.
-
-```bash
-mdbook watch path/to/book
-```
-
-#### --open
-
-When you use the `--open` (`-o`) option, mdbook will open the rendered book in
-your default web browser.
-
-#### --dest-dir
-
-The `--dest-dir` (`-d`) option allows you to change the output directory for your book.
-
------
-
-***note:*** *the `watch` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)*

book-example/src/format/config.md

@@ -1,28 +0,0 @@
-# Configuration
-
-You can configure the parameters for your book in the ***book.toml*** file.
-
-We encourage using the TOML format, but JSON is also recognized and parsed.
-
-Here is an example of what a ***book.toml*** file might look like:
-
-```toml
-title = "Example book"
-author = "Name"
-description = "The example book covers examples."
-dest = "output/my-book"
-```
-
-#### Supported variables
-
-If relative paths are given, they will be relative to the book's root, i.e. the
-parent directory of the source directory.
-
-- **title:** The title of the book.
-- **author:** The author of the book.
-- **description:** The description, which is added as meta in the html head of each page.
-- **src:** The path to the book's source files (chapters in Markdown, SUMMARY.md, etc.). Defaults to `root/src`.
-- **dest:** The path to the directory where you want your book to be rendered. Defaults to `root/book`.
-- **theme_path:** The path to a custom theme directory. Defaults to `root/theme`.
-
-***note:*** *the supported configurable parameters are scarce at the moment, but more will be added in the future*

book-example/src/format/mathjax.md

@@ -1,21 +0,0 @@
-# MathJax Support
-
-mdBook supports math equations through [MathJax](https://www.mathjax.org/).
-
-**However the normal method for indication math equations with `$$` does not work (yet?).**
-
-To indicate an inline equation \\( \int x = \frac{x^2}{2} \\) use
-```
-\\( \int x = \frac{x^2}{2} \\)
-```
-
-To indicate a block equation
-
-\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\]
-
-
-use
-
-```bash
-\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\]
-```

book-example/src/format/rust.md

@@ -1,42 +0,0 @@
-# Rust code specific features
-
-## Hiding code lines
-
-There is a feature in mdBook that let's you hide code lines by prepending them with a `#`.
-
-```bash
-# fn main() {
-    let x = 5;
-    let y = 6;
-
-    println!("{}", x + y);
-# }
-```
-
-Will render as
-
-```rust
-# fn main() {
-    let x = 5;
-    let y = 7;
-
-    println!("{}", x + y);
-# }
-```
-
-
-## Inserting runnable Rust files
-
-With the following syntax, you can insert runnable Rust files into your book:
-
-```hbs
-\{{#playpen file.rs}}
-```
-
-The path to the Rust file has to be relative from the current source file.
-
-When play is clicked, the code snippet will be send to the [Rust Playpen]() to be compiled and run. The result is send back and displayed directly underneath the code.
-
-Here is what a rendered code snippet looks like:
-
-{{#playpen example.rs}}

book-example/src/format/summary.md

@@ -1,32 +0,0 @@
-# SUMMARY.md
-
-The summary file is used by mdBook to know what chapters to include,
-in what order they should appear, what their hierarchy is and where the source files are.
-Without this file, there is no book.
-
-Even though `SUMMARY.md` is a markdown file, the formatting is very strict to
-allow for easy parsing. Let's see how you should format your `SUMMARY.md` file.
-
-#### Allowed elements
-
-1. ***Title*** It's common practice to begin with a title, generally
-   <code class="language-markdown"># Summary</code>.
-   But it is not mandatory, the parser just ignores it. So you can too
-   if you feel like it.
-
-2. ***Prefix Chapter*** Before the main numbered chapters you can add a couple of elements that will not be numbered. This is useful for
-   forewords, introductions, etc. There are however some constraints. You can not nest prefix chapters, they should all be on the root level. And you can not add prefix chapters once you have added numbered chapters.
-   ```markdown
-   [Title of prefix element](relative/path/to/markdown.md)
-   ```
-
-3. ***Numbered Chapter*** Numbered chapters are the main content of the book, they will be numbered and can be nested,
-   resulting in a nice hierarchy (chapters, sub-chapters, etc.)
-   ```markdown
-   - [Title of the Chapter](relative/path/to/markdown.md)
-   ```
-   You can either use `-` or `*` to indicate a numbered chapter.
-
-4. ***Suffix Chapter*** After the numbered chapters you can add a couple of non-numbered chapters. They are the same as prefix chapters but come after the numbered chapters instead of before.
-
-All other elements are unsupported and will be ignored at best or result in an error.

book-example/src/format/theme/index-hbs.md

@@ -1,91 +0,0 @@
-# index.hbs
-
-`index.hbs` is the handlebars template that is used to render the book.
-The markdown files are processed to html and then injected in that template.
-
-If you want to change the layout or style of your book, chances are that you will
-have to modify this template a little bit. Here is what you need to know.
-
-## Data
-
-A lot of data is exposed to the handlebars template with the "context".
-In the handlebars template you can access this information by using
-
-```handlebars
-{{name_of_property}}
-```
-
-Here is a list of the properties that are exposed:
-
-- ***language*** Language of the book in the form `en`. To use in <code class="language-html">\<html lang="{{ language }}"></code> for example.
-At the moment it is hardcoded.
-- ***title*** Title of the book, as specified in `book.toml`
-- ***chapter_title*** Title of the current chapter, as listed in `SUMMARY.md`
-
-- ***path*** Relative path to the original markdown file from the source directory
-- ***content*** This is the rendered markdown.
-- ***path_to_root*** This is a path containing exclusively `../`'s that points to the root of the book from the current file.
-Since the original directory structure is maintained, it is useful to prepend relative links with this `path_to_root`.
-
-- ***chapters*** Is an array of dictionaries of the form
-  ```json
-  {"section": "1.2.1", "name": "name of this chapter", "path": "dir/markdown.md"}
-  ```
-  containing all the chapters of the book. It is used for example to construct the table of contents (sidebar).
-
-## Handlebars Helpers
-
-In addition to the properties you can access, there are some handlebars helpers at your disposal.
-
-1.  ### toc
-
-    The toc helper is used like this
-
-    ```handlebars
-    {{#toc}}{{/toc}}
-    ```
-
-    and outputs something that looks like this, depending on the structure of your book
-
-    ```html
-    <ul class="chapter">
-        <li><a href="link/to/file.html">Some chapter</a></li>
-        <li>
-            <ul class="section">
-                <li><a href="link/to/other_file.html">Some other Chapter</a></li>
-            </ul>
-        </li>
-    </ul>
-    ```
-
-    If you would like to make a toc with another structure, you have access to the chapters property containing all the data.
-    The only limitation at the moment is that you would have to do it with JavaScript instead of with a handlebars helper.
-
-    ```html
-    <script>
-    var chapters = {{chapters}};
-    // Processing here
-    </script>
-    ```
-
-2.  ### previous / next
-
-    The previous and next helpers expose a `link` and `name` property to the previous and next chapters.
-
-    They are used like this
-
-    ```handlebars
-    {{#previous}}
-        <a href="{{link}}" class="nav-chapters previous">
-            <i class="fa fa-angle-left"></i>
-        </a>
-    {{/previous}}
-    ```
-
-    The inner html will only be rendered if the previous / next chapter exists.
-    Of course the inner html can be changed to your liking.
-
-------
-
-*If you would like me to expose other properties or helpers, please [create a new issue](https://github.com/azerupi/mdBook/issues)
-and I will consider it.*

book-example/src/format/theme/syntax-highlighting.md

@@ -1,60 +0,0 @@
-# Syntax Highlighting
-
-For syntax highlighting I use [Highlight.js](https://highlightjs.org) with a custom theme.
-
-Automatic language detection has been turned off, so you will probably want to
-specify the programming language you use like this
-
-<pre><code class="language-markdown">```rust
-fn main() {
-    // Some code
-}
-```</code></pre>
-
-## Custom theme
-Like the rest of the theme, the files used for syntax highlighting can be overridden with your own.
-
-- ***highlight.js*** normally you shouldn't have to overwrite this file, unless you want to use a more recent version.
-- ***highlight.css*** theme used by highlight.js for syntax highlighting.
-
-If you want to use another theme for `highlight.js` download it from their website, or make it yourself,
-rename it to `highlight.css` and put it in `src/theme` (or the equivalent if you changed your source folder)
-
-Now your theme will be used instead of the default theme.
-
-## Hiding code lines
-
-There is a feature in mdBook that let's you hide code lines by prepending them with a `#`.
-
-
-```bash
-# fn main() {
-    let x = 5;
-    let y = 6;
-
-    println!("{}", x + y);
-# }
-```
-
-Will render as
-
-```rust
-# fn main() {
-    let x = 5;
-    let y = 7;
-
-    println!("{}", x + y);
-# }
-```
-
-**At the moment, this only works for code examples that are annotated with `rust`. Because it would collide with semantics of some programming languages. In the future, we want to make this configurable through the `book.toml` so that everyone can benefit from it.**
-
-
-## Improve default theme
-
-If you think the default theme doesn't look quite right for a specific language, or could be improved.
-Feel free to [submit a new issue](https://github.com/azerupi/mdBook/issues) explaining what you have in mind and I will take a look at it.
-
-You could also create a pull-request with the proposed improvements.
-
-Overall the theme should be light and sober, without to many flashy colors.

book-example/src/format/theme/theme.md

@@ -1,22 +0,0 @@
-# Theme
-
-The default renderer uses a [handlebars](http://handlebarsjs.com/) template to render your markdown files and comes with a default theme
-included in the mdBook binary.
-
-The theme is totally customizable, you can selectively replace every file from the theme by your own by adding a
-`theme` directory in your source folder. Create a new file with the name of the file you want to override
-and now that file will be used instead of the default file.
-
-Here are the files you can override:
-
-- ***index.hbs*** is the handlebars template.
-- ***book.css*** is the style used in the output. If you want to change the design of your book, this is probably the file you want to modify. Sometimes in conjunction with `index.hbs` when you want to radically change the layout.
-- ***book.js*** is mostly used to add client side functionality, like hiding / un-hiding the sidebar, changing the theme, ...
-- ***highlight.js*** is the JavaScript that is used to highlight code snippets, you should not need to modify this.  
-- ***highlight.css*** is the theme used for the code highlighting
-- ***favicon.png*** the favicon that will be used
-
-Generally, when you want to tweak the theme, you don't need to override all the files. If you only need changes in the stylesheet,
-there is no point in overriding all the other files. Because custom files take precedence over built-in ones, they will not get updated with new fixes / features.
-
-**Note:** When you override a file, it is possible that you break some functionality. Therefore I recommend to use the file from the default theme as template and only add / modify what you need. You can copy the default theme into your source directory automatically by using `mdbook init --theme` just remove the files you don't want to override.

book-example/src/lib/lib.md

@@ -1,22 +0,0 @@
-# Rust Library
-
-mdBook is not only a command line tool, it can be used as a crate. You can extend it,
-integrate it in current projects. Here is a short example:
-
-```rust,ignore
-extern crate mdbook;
-
-use mdbook::MDBook;
-use std::path::Path;
-
-fn main() {
-    let mut book =  MDBook::new(Path::new("my-book"))   // Path to root
-                        .set_src(Path::new("src"))      // Path from root to source directory
-                        .set_dest(Path::new("book"))    // Path from root to output directory
-                        .read_config();                 // Parse book.toml or book.json file for configuration
-
-    book.build().unwrap();                              // Render the book
-}
-```
-
-Check here for the [API docs](../mdbook/index.html) generated by rustdoc.

build.rs

@@ -1,29 +0,0 @@
-// build.rs
-
-use std::process::Command;
-use std::env;
-use std::path::Path;
-
-fn main() {
-
-    if let Ok(_) = env::var("CARGO_FEATURE_REGENERATE_CSS") {
-
-        // Compile stylus stylesheet to css
-        let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
-
-        let theme_dir = Path::new(&manifest_dir).join("src/theme/");
-        let stylus_dir = theme_dir.join("stylus/book.styl");
-
-        if !Command::new("stylus")
-                .arg(format!("{}", stylus_dir.to_str().unwrap()))
-                .arg("--out")
-                .arg(format!("{}", theme_dir.to_str().unwrap()))
-                .arg("--use")
-                .arg("nib")
-                .status().unwrap()
-                .success() {
-            panic!("Stylus encoutered an error");
-        }
-    }
-
-}

ci/before_deploy.sh

@@ -1,32 +0,0 @@
-# `before_deploy` phase: here we package the build artifacts
-
-set -ex
-
-mktempd() {
-  echo $(mktemp -d 2>/dev/null || mktemp -d -t tmp)
-}
-
-mk_artifacts() {
-  cargo build --target $TARGET --release
-}
-
-mk_tarball() {
-  local td=$(mktempd)
-  local out_dir=$(pwd)
-
-  cp target/$TARGET/release/mdbook $td
-
-  pushd $td
-
-  tar czf $out_dir/${PROJECT_NAME}-${TRAVIS_TAG}-${TARGET}.tar.gz *
-
-  popd $td
-  rm -r $td
-}
-
-main() {
-  mk_artifacts
-  mk_tarball
-}
-
-main

ci/install-hub.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# Installs the `hub` executable into hub/bin
+set -ex
+case $1 in
+  ubuntu*)
+    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-linux-amd64-2.12.8.tgz -o hub.tgz
+    mkdir hub
+    tar -xzvf hub.tgz --strip=1 -C hub
+    ;;
+  macos*)
+    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-darwin-amd64-2.12.8.tgz -o hub.tgz
+    mkdir hub
+    tar -xzvf hub.tgz --strip=1 -C hub
+    ;;
+  windows*)
+    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-windows-amd64-2.12.8.zip -o hub.zip
+    7z x hub.zip -ohub
+    ;;
+  *)
+    echo "OS should be first parameter, was: $1"
+    ;;
+esac
+
+echo "$PWD/hub/bin" >> $GITHUB_PATH

ci/install-rust.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+# Install/update rust.
+# The first argument should be the toolchain to install.
+
+set -ex
+if [ -z "$1" ]
+then
+    echo "First parameter must be toolchain to install."
+    exit 1
+fi
+TOOLCHAIN="$1"
+
+rustup set profile minimal
+rustup component remove --toolchain=$TOOLCHAIN rust-docs || echo "already removed"
+rustup update --no-self-update $TOOLCHAIN
+rustup default $TOOLCHAIN
+rustup -V
+rustc -Vv
+cargo -V

ci/install.sh

@@ -1,58 +0,0 @@
-# `install` phase: install stuff needed for the `script` phase
-
-set -ex
-
-case "$TRAVIS_OS_NAME" in
-  linux)
-    host=x86_64-unknown-linux-gnu
-    ;;
-  osx)
-    host=x86_64-apple-darwin
-    ;;
-esac
-
-mktempd() {
-  echo $(mktemp -d 2>/dev/null || mktemp -d -t tmp)
-}
-
-install_rustup() {
-  local td=$(mktempd)
-
-  pushd $td
-  curl -O https://static.rust-lang.org/rustup/dist/$host/rustup-setup
-  chmod +x rustup-setup
-  ./rustup-setup -y
-  popd
-
-  rm -r $td
-
-  rustup default $CHANNEL
-  rustc -V
-  cargo -V
-}
-
-install_standard_crates() {
-  if [ "$host" != "$TARGET" ]; then
-    if [ ! "$CHANNEL" = "stable" ]; then
-      rustup target add $TARGET
-    else
-      local version=$(rustc -V | cut -d' ' -f2)
-      local tarball=rust-std-${version}-${TARGET}
-
-      local td=$(mktempd)
-      curl -s https://static.rust-lang.org/dist/${tarball}.tar.gz | \
-        tar --strip-components 1 -C $td -xz
-
-      $td/install.sh --prefix=$(rustc --print sysroot)
-
-      rm -r $td
-    fi
-  fi
-}
-
-main() {
-  install_rustup
-  install_standard_crates
-}
-
-main

ci/make-release.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+# Builds the release and creates an archive and optionally deploys to GitHub.
+set -ex
+
+if [[ -z "$GITHUB_REF" ]]
+then
+  echo "GITHUB_REF must be set"
+  exit 1
+fi
+# Strip mdbook-refs/tags/ from the start of the ref.
+TAG=${GITHUB_REF#*/tags/}
+
+host=$(rustc -Vv | grep ^host: | sed -e "s/host: //g")
+export CARGO_PROFILE_RELEASE_LTO=true
+cargo build --bin mdbook --release
+cd target/release
+case $1 in
+  ubuntu*)
+    asset="mdbook-$TAG-$host.tar.gz"
+    tar czf ../../$asset mdbook
+    ;;
+  macos*)
+    asset="mdbook-$TAG-$host.tar.gz"
+    # There is a bug with BSD tar on macOS where the first 8MB of the file are
+    # sometimes all NUL bytes. See https://github.com/actions/cache/issues/403
+    # and https://github.com/rust-lang/cargo/issues/8603 for some more
+    # information. An alternative solution here is to install GNU tar, but
+    # flushing the disk cache seems to work, too.
+    sudo /usr/sbin/purge
+    tar czf ../../$asset mdbook
+    ;;
+  windows*)
+    asset="mdbook-$TAG-$host.zip"
+    7z a ../../$asset mdbook.exe
+    ;;
+  *)
+    echo "OS should be first parameter, was: $1"
+    ;;
+esac
+cd ../..
+
+if [[ -z "$GITHUB_TOKEN" ]]
+then
+  echo "$GITHUB_TOKEN not set, skipping deploy."
+else
+  hub release edit -m "" --attach $asset $TAG
+fi

ci/script.sh

@@ -1,45 +0,0 @@
-# `script` phase: you usually build, test and generate docs in this phase
-
-set -ex
-
-# NOTE Workaround for rust-lang/rust#31907 - disable doc tests when cross compiling
-# This has been fixed in the nightly channel but it would take a while to reach the other channels
-disable_cross_doctests() {
-  local host
-  case "$TRAVIS_OS_NAME" in
-    linux)
-      host=x86_64-unknown-linux-gnu
-      ;;
-    osx)
-      host=x86_64-apple-darwin
-      ;;
-  esac
-
-  if [ "$host" != "$TARGET" ] && [ "$CHANNEL" != "nightly" ]; then
-    if [ "$TRAVIS_OS_NAME" = "osx" ]; then
-      brew install gnu-sed --default-names
-    fi
-
-    find src -name '*.rs' -type f | xargs sed -i -e 's:\(//.\s*```\):\1 ignore,:g'
-  fi
-}
-
-run_test_suite() {
-  # Extra test without default features to avoid bitrot. We only test on a single target (but with
-  # all the channels) to avoid significantly increasing the build times
-  if [ $TARGET = x86_64-unknown-linux-gnu ]; then
-    cargo build --target $TARGET --no-default-features --verbose
-    cargo test --target $TARGET --no-default-features --verbose
-    cargo clean
-  fi
-
-  cargo build --target $TARGET --verbose
-  cargo test --target $TARGET --verbose
-}
-
-main() {
-  disable_cross_doctests
-  run_test_suite
-}
-
-main

deploy.sh

@@ -1,42 +0,0 @@
-#!/bin/bash
-
-# Exit on error or variable unset
-set -o errexit -o nounset
-
-NC='\033[39m'
-CYAN='\033[36m'
-GREEN='\033[32m'
-
-rev=$(git rev-parse --short HEAD)
-
-echo -e "${CYAN}Running cargo doc${NC}"
-# Run cargo doc
-cargo doc
-
-echo -e "${CYAN}Running mdbook build${NC}"
-# Run mdbook to generate the book
-target/"$TARGET"/debug/mdbook build book-example/
-
-echo -e "${CYAN}Copying book to target/doc${NC}"
-# Copy files from rendered book to doc root
-cp -R book-example/book/* target/doc/
-
-cd target/doc
-
-echo -e "${CYAN}Initializing Git${NC}"
-git init
-git config user.name "Mathieu David"
-git config user.email "mathieudavid@mathieudavid.org"
-
-git remote add upstream "https://$GH_TOKEN@github.com/azerupi/mdBook.git"
-git fetch upstream
-git reset upstream/gh-pages
-
-touch .
-
-echo -e "${CYAN}Pushing changes to gh-pages${NC}"
-git add -A .
-git commit -m "rebuild pages at ${rev}"
-git push -q upstream HEAD:gh-pages
-
-echo -e "${GREEN}Deployement done${NC}"

examples/nop-preprocessor.rs

@@ -0,0 +1,102 @@
+use crate::nop_lib::Nop;
+use clap::{App, Arg, ArgMatches, SubCommand};
+use mdbook::book::Book;
+use mdbook::errors::Error;
+use mdbook::preprocess::{CmdPreprocessor, Preprocessor, PreprocessorContext};
+use std::io;
+use std::process;
+
+pub fn make_app() -> App<'static, 'static> {
+    App::new("nop-preprocessor")
+        .about("A mdbook preprocessor which does precisely nothing")
+        .subcommand(
+            SubCommand::with_name("supports")
+                .arg(Arg::with_name("renderer").required(true))
+                .about("Check whether a renderer is supported by this preprocessor"),
+        )
+}
+
+fn main() {
+    let matches = make_app().get_matches();
+
+    // Users will want to construct their own preprocessor here
+    let preprocessor = Nop::new();
+
+    if let Some(sub_args) = matches.subcommand_matches("supports") {
+        handle_supports(&preprocessor, sub_args);
+    } else if let Err(e) = handle_preprocessing(&preprocessor) {
+        eprintln!("{}", e);
+        process::exit(1);
+    }
+}
+
+fn handle_preprocessing(pre: &dyn Preprocessor) -> Result<(), Error> {
+    let (ctx, book) = CmdPreprocessor::parse_input(io::stdin())?;
+
+    if ctx.mdbook_version != mdbook::MDBOOK_VERSION {
+        // We should probably use the `semver` crate to check compatibility
+        // here...
+        eprintln!(
+            "Warning: The {} plugin was built against version {} of mdbook, \
+             but we're being called from version {}",
+            pre.name(),
+            mdbook::MDBOOK_VERSION,
+            ctx.mdbook_version
+        );
+    }
+
+    let processed_book = pre.run(&ctx, book)?;
+    serde_json::to_writer(io::stdout(), &processed_book)?;
+
+    Ok(())
+}
+
+fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
+    let renderer = sub_args.value_of("renderer").expect("Required argument");
+    let supported = pre.supports_renderer(&renderer);
+
+    // Signal whether the renderer is supported by exiting with 1 or 0.
+    if supported {
+        process::exit(0);
+    } else {
+        process::exit(1);
+    }
+}
+
+/// The actual implementation of the `Nop` preprocessor. This would usually go
+/// in your main `lib.rs` file.
+mod nop_lib {
+    use super::*;
+
+    /// A no-op preprocessor.
+    pub struct Nop;
+
+    impl Nop {
+        pub fn new() -> Nop {
+            Nop
+        }
+    }
+
+    impl Preprocessor for Nop {
+        fn name(&self) -> &str {
+            "nop-preprocessor"
+        }
+
+        fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book, Error> {
+            // In testing we want to tell the preprocessor to blow up by setting a
+            // particular config value
+            if let Some(nop_cfg) = ctx.config.get_preprocessor(self.name()) {
+                if nop_cfg.contains_key("blow-up") {
+                    anyhow::bail!("Boom!!1!");
+                }
+            }
+
+            // we *are* a no-op preprocessor after all
+            Ok(book)
+        }
+
+        fn supports_renderer(&self, renderer: &str) -> bool {
+            renderer != "not-supported"
+        }
+    }
+}

guide/book.toml

@@ -0,0 +1,25 @@
+[book]
+title = "mdBook Documentation"
+description = "Create book from markdown files. Like Gitbook but implemented in Rust"
+authors = ["Mathieu David", "Michael-F-Bryan"]
+language = "en"
+
+[rust]
+edition = "2018"
+
+[output.html]
+mathjax-support = true
+site-url = "/mdBook/"
+
+[output.html.playground]
+editable = true
+line-numbers = true
+
+[output.html.search]
+limit-results = 20
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 2
+boost-paragraph = 1
+expand = true
+heading-split-level = 2

guide/src/404.md

@@ -0,0 +1,3 @@
+# Document not found (404)
+
+This URL is invalid, sorry. Try the search instead!

guide/src/README.md

@@ -0,0 +1,25 @@
+# mdBook
+
+**mdBook** is a command line tool and Rust crate to create books using Markdown
+(as by the [CommonMark](https://commonmark.org/) specification) files. It's very
+similar to Gitbook but written in [Rust](http://www.rust-lang.org).
+
+What you are reading serves as an example of the output of mdBook and at the
+same time as a high-level documentation.
+
+mdBook is free and open source, you can find the source code on
+[GitHub](https://github.com/rust-lang/mdBook). Issues and feature
+requests can be posted on the [GitHub issue
+tracker](https://github.com/rust-lang/mdBook/issues).
+
+## API docs
+
+Alongside this book you can also read the [API
+docs](https://docs.rs/mdbook/*/mdbook/) generated by Rustdoc if you would like
+to use mdBook as a crate or write a new renderer and need a more low-level
+overview.
+
+## License
+
+mdBook, all the source code, is released under the [Mozilla Public License
+v2.0](https://www.mozilla.org/MPL/2.0/).

guide/src/SUMMARY.md

@@ -0,0 +1,28 @@
+# Summary
+
+- [mdBook](README.md)
+- [Command Line Tool](cli/README.md)
+    - [init](cli/init.md)
+    - [build](cli/build.md)
+    - [watch](cli/watch.md)
+    - [serve](cli/serve.md)
+    - [test](cli/test.md)
+    - [clean](cli/clean.md)
+- [Format](format/README.md)
+    - [SUMMARY.md](format/summary.md)
+        - [Draft chapter]()
+    - [Configuration](format/config.md)
+    - [Theme](format/theme/README.md)
+        - [index.hbs](format/theme/index-hbs.md)
+        - [Syntax highlighting](format/theme/syntax-highlighting.md)
+        - [Editor](format/theme/editor.md)
+    - [MathJax Support](format/mathjax.md)
+    - [mdBook-specific features](format/mdbook.md)
+- [Continuous Integration](continuous-integration.md)
+- [For Developers](for_developers/README.md)
+    - [Preprocessors](for_developers/preprocessors.md)
+    - [Alternative Backends](for_developers/backends.md)
+
+-----------
+
+[Contributors](misc/contributors.md)

guide/src/cli/README.md

@@ -0,0 +1,55 @@
+# Command Line Tool
+
+mdBook can be used either as a command line tool or a [Rust
+crate](https://crates.io/crates/mdbook). Let's focus on the command line tool
+capabilities first.
+
+## Install From Binaries
+
+Precompiled binaries are provided for major platforms on a best-effort basis.
+Visit [the releases page](https://github.com/rust-lang/mdBook/releases)
+to download the appropriate version for your platform.
+
+## Install From Source
+
+mdBook can also be installed from source
+
+### Pre-requisite
+
+mdBook is written in **[Rust](https://www.rust-lang.org/)** and therefore needs
+to be compiled with **Cargo**. If you haven't already installed Rust, please go
+ahead and [install it](https://www.rust-lang.org/tools/install) now.
+
+### Install Crates.io version
+
+Installing mdBook is relatively easy if you already have Rust and Cargo
+installed. You just have to type this snippet in your terminal:
+
+```bash
+cargo install mdbook
+```
+
+This will fetch the source code for the latest release from
+[Crates.io](https://crates.io/) and compile it. You will have to add Cargo's
+`bin` directory to your `PATH`.
+
+Run `mdbook help` in your terminal to verify if it works. Congratulations, you
+have installed mdBook!
+
+
+### Install Git version
+
+The **[git version](https://github.com/rust-lang/mdBook)** contains all
+the latest bug-fixes and features, that will be released in the next version on
+**Crates.io**, if you can't wait until the next release. You can build the git
+version yourself. Open your terminal and navigate to the directory of you
+choice. We need to clone the git repository and then build it with Cargo.
+
+```bash
+git clone --depth=1 https://github.com/rust-lang/mdBook.git
+cd mdBook
+cargo build --release
+```
+
+The executable `mdbook` will be in the `./target/release` folder, this should be
+added to the path.

guide/src/cli/build.md

@@ -0,0 +1,39 @@
+# The build command
+
+The build command is used to render your book:
+
+```bash
+mdbook build
+```
+
+It will try to parse your `SUMMARY.md` file to understand the structure of your
+book and fetch the corresponding files.
+
+The rendered output will maintain the same directory structure as the source for
+convenience. Large books will therefore remain structured when rendered.
+
+#### Specify a directory
+
+The `build` command can take a directory as an argument to use as the book's
+root instead of the current working directory.
+
+```bash
+mdbook build path/to/book
+```
+
+#### --open
+
+When you use the `--open` (`-o`) flag, mdbook will open the rendered book in
+your default web browser after building it.
+
+#### --dest-dir
+
+The `--dest-dir` (`-d`) option allows you to change the output directory for the
+book. Relative paths are interpreted relative to the book's root directory. If
+not specified it will default to the value of the `build.build-dir` key in
+`book.toml`, or to `./book`.
+
+-------------------
+
+***Note:*** *The build command copies all files (excluding files with `.md` extension) from the source directory
+into the build directory.*

guide/src/cli/clean.md

@@ -0,0 +1,30 @@
+# The clean command
+
+The clean command is used to delete the generated book and any other build
+artifacts.
+
+```bash
+mdbook clean
+```
+
+#### Specify a directory
+
+The `clean` command can take a directory as an argument to use as the book's
+root instead of the current working directory.
+
+```bash
+mdbook clean path/to/book
+```
+
+#### --dest-dir
+
+The `--dest-dir` (`-d`) option allows you to override the book's output
+directory, which will be deleted by this command. Relative paths are interpreted
+relative to the book's root directory. If not specified it will default to the
+value of the `build.build-dir` key in `book.toml`, or to `./book`.
+
+```bash
+mdbook clean --dest-dir=path/to/book
+```
+
+`path/to/book` could be absolute or relative.

guide/src/cli/init.md

@@ -0,0 +1,54 @@
+# The init command
+
+There is some minimal boilerplate that is the same for every new book. It's for
+this purpose that mdBook includes an `init` command.
+
+The `init` command is used like this:
+
+```bash
+mdbook init
+```
+
+When using the `init` command for the first time, a couple of files will be set
+up for you:
+```bash
+book-test/
+├── book
+└── src
+    ├── chapter_1.md
+    └── SUMMARY.md
+```
+
+- The `src` directory is where you write your book in markdown. It contains all
+  the source files, configuration files, etc.
+
+- The `book` directory is where your book is rendered. All the output is ready
+  to be uploaded to a server to be seen by your audience.
+
+- The `SUMMARY.md` file is the most important file, it's the skeleton of your
+  book and is discussed in more detail [in another
+  chapter](../format/summary.md)
+
+#### Tip: Generate chapters from SUMMARY.md
+
+When a `SUMMARY.md` file already exists, the `init` command will first parse it
+and generate the missing files according to the paths used in the `SUMMARY.md`.
+This allows you to think and create the whole structure of your book and then
+let mdBook generate it for you.
+
+#### Specify a directory
+
+The `init` command can take a directory as an argument to use as the book's root
+instead of the current working directory.
+
+```bash
+mdbook init path/to/book
+```
+
+#### --theme
+
+When you use the `--theme` flag, the default theme will be copied into a
+directory called `theme` in your source directory so that you can modify it.
+
+The theme is selectively overwritten, this means that if you don't want to
+overwrite a specific file, just delete it and the default file will be used.

guide/src/cli/serve.md

@@ -0,0 +1,59 @@
+# The serve command
+
+The serve command is used to preview a book by serving it over HTTP at
+`localhost:3000` by default. Additionally it watches the book's directory for
+changes, rebuilding the book and refreshing clients for each change. A websocket
+connection is used to trigger the client-side refresh.
+
+***Note:*** *The `serve` command is for testing a book's HTML output, and is not
+intended to be a complete HTTP server for a website.*
+
+#### Specify a directory
+
+The `serve` command can take a directory as an argument to use as the book's
+root instead of the current working directory.
+
+```bash
+mdbook serve path/to/book
+```
+
+#### Server options
+
+`serve` has four options: the HTTP port, the WebSocket port, the HTTP hostname
+to listen on, and the hostname for the browser to connect to for WebSockets.
+
+For example: suppose you have an nginx server for SSL termination which has a
+public address of 192.168.1.100 on port 80 and proxied that to 127.0.0.1 on port
+8000\. To run use the nginx proxy do:
+
+```bash
+mdbook serve path/to/book -p 8000 -n 127.0.0.1 --websocket-hostname 192.168.1.100
+```
+
+If you were to want live reloading for this you would need to proxy the
+websocket calls through nginx as well from `192.168.1.100:<WS_PORT>` to
+`127.0.0.1:<WS_PORT>`. The `-w` flag allows for the websocket port to be
+configured.
+
+#### --open
+
+When you use the `--open` (`-o`) flag, mdbook will open the book in your
+default web browser after starting the server.
+
+#### --dest-dir
+
+The `--dest-dir` (`-d`) option allows you to change the output directory for the
+book. Relative paths are interpreted relative to the book's root directory. If
+not specified it will default to the value of the `build.build-dir` key in
+`book.toml`, or to `./book`.
+
+#### Specify exclude patterns
+
+The `serve` command will not automatically trigger a build for files listed in
+the `.gitignore` file in the book root directory. The `.gitignore` file may
+contain file patterns described in the [gitignore
+documentation](https://git-scm.com/docs/gitignore). This can be useful for
+ignoring temporary files created by some editors.
+
+_Note: Only `.gitignore` from book root directory is used. Global
+`$HOME/.gitignore` or `.gitignore` files in parent directories are not used._

guide/src/cli/test.md

@@ -0,0 +1,53 @@
+# The test command
+
+When writing a book, you sometimes need to automate some tests. For example,
+[The Rust Programming Book](https://doc.rust-lang.org/stable/book/) uses a lot
+of code examples that could get outdated. Therefore it is very important for
+them to be able to automatically test these code examples.
+
+mdBook supports a `test` command that will run all available tests in a book. At
+the moment, only rustdoc tests are supported, but this may be expanded upon in
+the future.
+
+#### Disable tests on a code block
+
+rustdoc doesn't test code blocks which contain the `ignore` attribute:
+
+    ```rust,ignore
+    fn main() {}
+    ```
+
+rustdoc also doesn't test code blocks which specify a language other than Rust:
+
+    ```markdown
+    **Foo**: _bar_
+    ```
+
+rustdoc *does* test code blocks which have no language specified:
+
+    ```
+    This is going to cause an error!
+    ```
+
+#### Specify a directory
+
+The `test` command can take a directory as an argument to use as the book's root
+instead of the current working directory.
+
+```bash
+mdbook test path/to/book
+```
+
+#### --library-path
+
+The `--library-path` (`-L`) option allows you to add directories to the library
+search path used by `rustdoc` when it builds and tests the examples. Multiple
+directories can be specified with multiple options (`-L foo -L bar`) or with a
+comma-delimited list (`-L foo,bar`).
+
+#### --dest-dir
+
+The `--dest-dir` (`-d`) option allows you to change the output directory for the
+book. Relative paths are interpreted relative to the book's root directory. If
+not specified it will default to the value of the `build.build-dir` key in
+`book.toml`, or to `./book`.

guide/src/cli/watch.md

@@ -0,0 +1,39 @@
+# The watch command
+
+The `watch` command is useful when you want your book to be rendered on every
+file change. You could repeatedly issue `mdbook build` every time a file is
+changed. But using `mdbook watch` once will watch your files and will trigger a
+build automatically whenever you modify a file.
+
+#### Specify a directory
+
+The `watch` command can take a directory as an argument to use as the book's
+root instead of the current working directory.
+
+```bash
+mdbook watch path/to/book
+```
+
+#### --open
+
+When you use the `--open` (`-o`) option, mdbook will open the rendered book in
+your default web browser.
+
+#### --dest-dir
+
+The `--dest-dir` (`-d`) option allows you to change the output directory for the
+book. Relative paths are interpreted relative to the book's root directory. If
+not specified it will default to the value of the `build.build-dir` key in
+`book.toml`, or to `./book`.
+
+
+#### Specify exclude patterns
+
+The `watch` command will not automatically trigger a build for files listed in
+the `.gitignore` file in the book root directory. The `.gitignore` file may
+contain file patterns described in the [gitignore
+documentation](https://git-scm.com/docs/gitignore). This can be useful for
+ignoring temporary files created by some editors.
+
+_Note: Only `.gitignore` from book root directory is used. Global
+`$HOME/.gitignore` or `.gitignore` files in parent directories are not used._

guide/src/continuous-integration.md

@@ -0,0 +1,89 @@
+# Running `mdbook` in Continuous Integration
+
+While the following examples use Travis CI, their principles should
+straightforwardly transfer to other continuous integration providers as well.
+
+## Ensuring Your Book Builds and Tests Pass
+
+Here is a sample Travis CI `.travis.yml` configuration that ensures `mdbook
+build` and `mdbook test` run successfully. The key to fast CI turnaround times
+is caching `mdbook` installs, so that you aren't compiling `mdbook` on every CI
+run.
+
+```yaml
+language: rust
+sudo: false
+
+cache:
+  - cargo
+
+rust:
+  - stable
+
+before_script:
+  - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update)
+  - (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.3" mdbook)
+  - cargo install-update -a
+
+script:
+  - mdbook build path/to/mybook && mdbook test path/to/mybook
+```
+
+## Deploying Your Book to GitHub Pages
+
+Following these instructions will result in your book being published to GitHub
+pages after a successful CI run on your repository's `master` branch.
+
+First, create a new GitHub "Personal Access Token" with the "public_repo"
+permissions (or "repo" for private repositories). Go to your repository's Travis
+CI settings page and add an environment variable named `GITHUB_TOKEN` that is
+marked secure and *not* shown in the logs.
+
+Then, append this snippet to your `.travis.yml` and update the path to the
+`book` directory:
+
+```yaml
+deploy:
+  provider: pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  local-dir: path/to/mybook/book
+  keep-history: false
+  on:
+    branch: master
+```
+
+That's it!
+
+### Deploying to GitHub Pages manually
+
+If your CI doesn't support GitHub pages, or you're deploying somewhere else
+with integrations such as Github Pages:
+ *note: you may want to use different tmp dirs*:
+
+```console
+$> git worktree add /tmp/book gh-pages
+$> mdbook build
+$> rm -rf /tmp/book/* # this won't delete the .git directory
+$> cp -rp book/* /tmp/book/
+$> cd /tmp/book
+$> git add -A
+$> git commit 'new book message'
+$> git push origin gh-pages
+$> cd -
+```
+
+Or put this into a Makefile rule:
+
+```makefile
+.PHONY: deploy
+deploy: book
+	@echo "====> deploying to github"
+	git worktree add /tmp/book gh-pages
+	rm -rf /tmp/book/*
+	cp -rp book/* /tmp/book/
+	cd /tmp/book && \
+		git add -A && \
+		git commit -m "deployed on $(shell date) by ${USER}" && \
+		git push origin gh-pages
+```

guide/src/for_developers/README.md

@@ -0,0 +1,46 @@
+# For Developers
+
+While `mdbook` is mainly used as a command line tool, you can also import the
+underlying library directly and use that to manage a book. It also has a fairly
+flexible plugin mechanism, allowing you to create your own custom tooling and
+consumers (often referred to as *backends*) if you need to do some analysis of
+the book or render it in a different format.
+
+The *For Developers* chapters are here to show you the more advanced usage of
+`mdbook`.
+
+The two main ways a developer can hook into the book's build process is via,
+
+- [Preprocessors](preprocessors.md)
+- [Alternative Backends](backends.md)
+
+
+## The Build Process
+
+The process of rendering a book project goes through several steps.
+
+1. Load the book
+    - Parse the `book.toml`, falling back to the default `Config` if it doesn't
+       exist
+    - Load the book chapters into memory
+    - Discover which preprocessors/backends should be used
+2. Run the preprocessors
+3. Call each backend in turn
+
+
+## Using `mdbook` as a Library
+
+The `mdbook` binary is just a wrapper around the `mdbook` crate, exposing its
+functionality as a command-line program. As such it is quite easy to create your
+own programs which use `mdbook` internally, adding your own functionality (e.g.
+a custom preprocessor) or tweaking the build process.
+
+The easiest way to find out how to use the `mdbook` crate is by looking at the
+[API Docs]. The top level documentation explains how one would use the
+[`MDBook`] type to load and build a book, while the [config] module gives a good
+explanation on the configuration system.
+
+
+[`MDBook`]: https://docs.rs/mdbook/*/mdbook/book/struct.MDBook.html
+[API Docs]: https://docs.rs/mdbook/*/mdbook/
+[config]: https://docs.rs/mdbook/*/mdbook/config/index.html

guide/src/for_developers/backends.md

@@ -0,0 +1,387 @@
+# Alternative Backends
+
+A "backend" is simply a program which `mdbook` will invoke during the book
+rendering process. This program is passed a JSON representation of the book and
+configuration information via `stdin`. Once the backend receives this
+information it is free to do whatever it wants.
+
+There are already several alternative backends on GitHub which can be used as a
+rough example of how this is accomplished in practice.
+
+- [mdbook-linkcheck] - a simple program for verifying the book doesn't contain
+  any broken links
+- [mdbook-epub] - an EPUB renderer
+- [mdbook-test] - a program to run the book's contents through [rust-skeptic] to
+  verify everything compiles and runs correctly (similar to `rustdoc --test`)
+
+This page will step you through creating your own alternative backend in the form
+of a simple word counting program. Although it will be written in Rust, there's
+no reason why it couldn't be accomplished using something like Python or Ruby.
+
+
+## Setting Up
+
+First you'll want to create a new binary program and add `mdbook` as a
+dependency.
+
+```shell
+$ cargo new --bin mdbook-wordcount
+$ cd mdbook-wordcount
+$ cargo add mdbook
+```
+
+When our `mdbook-wordcount` plugin is invoked, `mdbook` will send it a JSON
+version of [`RenderContext`] via our plugin's `stdin`. For convenience, there's
+a [`RenderContext::from_json()`] constructor which will load a `RenderContext`.
+
+This is all the boilerplate necessary for our backend to load the book.
+
+```rust
+// src/main.rs
+extern crate mdbook;
+
+use std::io;
+use mdbook::renderer::RenderContext;
+
+fn main() {
+    let mut stdin = io::stdin();
+    let ctx = RenderContext::from_json(&mut stdin).unwrap();
+}
+```
+
+> **Note:** The `RenderContext` contains a `version` field. This lets backends
+  figure out whether they are compatible with the version of `mdbook` it's being
+  called by. This `version` comes directly from the corresponding field in
+  `mdbook`'s `Cargo.toml`.
+
+  It is recommended that backends use the [`semver`] crate to inspect this field
+  and emit a warning if there may be a compatibility issue.
+
+
+## Inspecting the Book
+
+Now our backend has a copy of the book, lets count how many words are in each
+chapter!
+
+Because the `RenderContext` contains a [`Book`] field (`book`), and a `Book` has
+the [`Book::iter()`] method for iterating over all items in a `Book`, this step
+turns out to be just as easy as the first.
+
+```rust
+
+fn main() {
+    let mut stdin = io::stdin();
+    let ctx = RenderContext::from_json(&mut stdin).unwrap();
+
+    for item in ctx.book.iter() {
+        if let BookItem::Chapter(ref ch) = *item {
+            let num_words = count_words(ch);
+            println!("{}: {}", ch.name, num_words);
+        }
+    }
+}
+
+fn count_words(ch: &Chapter) -> usize {
+    ch.content.split_whitespace().count()
+}
+```
+
+
+## Enabling the Backend
+
+Now we've got the basics running, we want to actually use it. First, install the
+program.
+
+```shell
+$ cargo install --path .
+```
+
+Then `cd` to the particular book you'd like to count the words of and update its
+`book.toml` file.
+
+```diff
+  [book]
+  title = "mdBook Documentation"
+  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
+  authors = ["Mathieu David", "Michael-F-Bryan"]
+
++ [output.html]
+
++ [output.wordcount]
+```
+
+When it loads a book into memory, `mdbook` will inspect your `book.toml` file to
+try and figure out which backends to use by looking for all `output.*` tables.
+If none are provided it'll fall back to using the default HTML renderer.
+
+Notably, this means if you want to add your own custom backend you'll also need
+to make sure to add the HTML backend, even if its table just stays empty.
+
+Now you just need to build your book like normal, and everything should *Just
+Work*.
+
+```shell
+$ mdbook build
+...
+2018-01-16 07:31:15 [INFO] (mdbook::renderer): Invoking the "mdbook-wordcount" renderer
+mdBook: 126
+Command Line Tool: 224
+init: 283
+build: 145
+watch: 146
+serve: 292
+test: 139
+Format: 30
+SUMMARY.md: 259
+Configuration: 784
+Theme: 304
+index.hbs: 447
+Syntax highlighting: 314
+MathJax Support: 153
+Rust code specific features: 148
+For Developers: 788
+Alternative Backends: 710
+Contributors: 85
+```
+
+The reason we didn't need to specify the full name/path of our `wordcount`
+backend is because `mdbook` will try to *infer* the program's name via
+convention. The executable for the `foo` backend is typically called
+`mdbook-foo`, with an associated `[output.foo]` entry in the `book.toml`. To
+explicitly tell `mdbook` what command to invoke (it may require command-line
+arguments or be an interpreted script), you can use the `command` field.
+
+```diff
+  [book]
+  title = "mdBook Documentation"
+  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
+  authors = ["Mathieu David", "Michael-F-Bryan"]
+
+  [output.html]
+
+  [output.wordcount]
++ command = "python /path/to/wordcount.py"
+```
+
+
+## Configuration
+
+Now imagine you don't want to count the number of words on a particular chapter
+(it might be generated text/code, etc). The canonical way to do this is via the
+usual `book.toml` configuration file by adding items to your `[output.foo]`
+table.
+
+The `Config` can be treated roughly as a nested hashmap which lets you call
+methods like `get()` to access the config's contents, with a
+`get_deserialized()` convenience method for retrieving a value and automatically
+deserializing to some arbitrary type `T`.
+
+To implement this, we'll create our own serializable `WordcountConfig` struct
+which will encapsulate all configuration for this backend.
+
+First add `serde` and `serde_derive` to your `Cargo.toml`,
+
+```
+$ cargo add serde serde_derive
+```
+
+And then you can create the config struct,
+
+```rust
+extern crate serde;
+#[macro_use]
+extern crate serde_derive;
+
+...
+
+#[derive(Debug, Default, Serialize, Deserialize)]
+#[serde(default, rename_all = "kebab-case")]
+pub struct WordcountConfig {
+  pub ignores: Vec<String>,
+}
+```
+
+Now we just need to deserialize the `WordcountConfig` from our `RenderContext`
+and then add a check to make sure we skip ignored chapters.
+
+```diff
+  fn main() {
+      let mut stdin = io::stdin();
+      let ctx = RenderContext::from_json(&mut stdin).unwrap();
++     let cfg: WordcountConfig = ctx.config
++         .get_deserialized("output.wordcount")
++         .unwrap_or_default();
+
+      for item in ctx.book.iter() {
+          if let BookItem::Chapter(ref ch) = *item {
++             if cfg.ignores.contains(&ch.name) {
++                 continue;
++             }
++
+              let num_words = count_words(ch);
+              println!("{}: {}", ch.name, num_words);
+          }
+      }
+  }
+```
+
+
+## Output and Signalling Failure
+
+While it's nice to print word counts to the terminal when a book is built, it
+might also be a good idea to output them to a file somewhere. `mdbook` tells a
+backend where it should place any generated output via the `destination` field
+in [`RenderContext`].
+
+```diff
++ use std::fs::{self, File};
++ use std::io::{self, Write};
+- use std::io;
+  use mdbook::renderer::RenderContext;
+  use mdbook::book::{BookItem, Chapter};
+
+  fn main() {
+    ...
+
++     let _ = fs::create_dir_all(&ctx.destination);
++     let mut f = File::create(ctx.destination.join("wordcounts.txt")).unwrap();
++
+      for item in ctx.book.iter() {
+          if let BookItem::Chapter(ref ch) = *item {
+              ...
+
+              let num_words = count_words(ch);
+              println!("{}: {}", ch.name, num_words);
++             writeln!(f, "{}: {}", ch.name, num_words).unwrap();
+          }
+      }
+  }
+```
+
+> **Note:** There is no guarantee that the destination directory exists or is
+> empty (`mdbook` may leave the previous contents to let backends do caching),
+> so it's always a good idea to create it with `fs::create_dir_all()`.
+>
+> If the destination directory already exists, don't assume it will be empty.
+> To allow backends to cache the results from previous runs, `mdbook` may leave
+> old content in the directory.
+
+There's always the possibility that an error will occur while processing a book
+(just look at all the `unwrap()`'s we've written already), so `mdbook` will
+interpret a non-zero exit code as a rendering failure.
+
+For example, if we wanted to make sure all chapters have an *even* number of
+words, erroring out if an odd number is encountered, then you may do something
+like this:
+
+```diff
++ use std::process;
+  ...
+
+  fn main() {
+      ...
+
+      for item in ctx.book.iter() {
+          if let BookItem::Chapter(ref ch) = *item {
+              ...
+
+              let num_words = count_words(ch);
+              println!("{}: {}", ch.name, num_words);
+              writeln!(f, "{}: {}", ch.name, num_words).unwrap();
+
++             if cfg.deny_odds && num_words % 2 == 1 {
++               eprintln!("{} has an odd number of words!", ch.name);
++               process::exit(1);
+              }
+          }
+      }
+  }
+
+  #[derive(Debug, Default, Serialize, Deserialize)]
+  #[serde(default, rename_all = "kebab-case")]
+  pub struct WordcountConfig {
+      pub ignores: Vec<String>,
++     pub deny_odds: bool,
+  }
+```
+
+Now, if we reinstall the backend and build a book,
+
+```shell
+$ cargo install --path . --force
+$ mdbook build /path/to/book
+...
+2018-01-16 21:21:39 [INFO] (mdbook::renderer): Invoking the "wordcount" renderer
+mdBook: 126
+Command Line Tool: 224
+init: 283
+init has an odd number of words!
+2018-01-16 21:21:39 [ERROR] (mdbook::renderer): Renderer exited with non-zero return code.
+2018-01-16 21:21:39 [ERROR] (mdbook::utils): Error: Rendering failed
+2018-01-16 21:21:39 [ERROR] (mdbook::utils):    Caused By: The "mdbook-wordcount" renderer failed
+```
+
+As you've probably already noticed, output from the plugin's subprocess is
+immediately passed through to the user. It is encouraged for plugins to follow
+the "rule of silence" and only generate output when necessary (e.g. an error in
+generation or a warning).
+
+All environment variables are passed through to the backend, allowing you to use
+the usual `RUST_LOG` to control logging verbosity.
+
+## Handling missing backends
+
+If you enable a backend that isn't installed, the default behavior is to throw an error:
+
+```text
+The command `mdbook-wordcount` wasn't found, is the "wordcount" backend installed?
+If you want to ignore this error when the "wordcount" backend is not installed,
+set `optional = true` in the `[output.wordcount]` section of the book.toml configuration file.
+```
+
+This behavior can be changed by marking the backend as optional.
+
+```diff
+  [book]
+  title = "mdBook Documentation"
+  description = "Create book from markdown files. Like Gitbook but implemented in Rust"
+  authors = ["Mathieu David", "Michael-F-Bryan"]
+
+  [output.html]
+
+  [output.wordcount]
+  command = "python /path/to/wordcount.py"
++ optional = true
+```
+
+This demotes the error to a warning, and it will instead look like this:
+
+```text
+The command was not found, but was marked as optional.
+    Command: wordcount
+```
+
+
+## Wrapping Up
+
+Although contrived, hopefully this example was enough to show how you'd create
+an alternative backend for `mdbook`. If you feel it's missing something, don't
+hesitate to create an issue in the [issue tracker] so we can improve the user
+guide.
+
+The existing backends mentioned towards the start of this chapter should serve
+as a good example of how it's done in real life, so feel free to skim through
+the source code or ask questions.
+
+
+[mdbook-linkcheck]: https://github.com/Michael-F-Bryan/mdbook-linkcheck
+[mdbook-epub]: https://github.com/Michael-F-Bryan/mdbook-epub
+[mdbook-test]: https://github.com/Michael-F-Bryan/mdbook-test
+[rust-skeptic]: https://github.com/budziq/rust-skeptic
+[`RenderContext`]: https://docs.rs/mdbook/*/mdbook/renderer/struct.RenderContext.html
+[`RenderContext::from_json()`]: https://docs.rs/mdbook/*/mdbook/renderer/struct.RenderContext.html#method.from_json
+[`semver`]: https://crates.io/crates/semver
+[`Book`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html
+[`Book::iter()`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html#method.iter
+[`Config`]: https://docs.rs/mdbook/*/mdbook/config/struct.Config.html
+[issue tracker]: https://github.com/rust-lang/mdBook/issues

guide/src/for_developers/mdbook-wordcount/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "mdbook-wordcount"
+version = "0.1.0"
+authors = ["Michael Bryan <michaelfbryan@gmail.com>"]
+
+[dependencies]
+mdbook = { path = "../../../..", version = "*" }
+serde = "1.0"
+serde_derive = "1.0"

guide/src/for_developers/mdbook-wordcount/src/main.rs

@@ -0,0 +1,49 @@
+extern crate mdbook;
+extern crate serde;
+#[macro_use]
+extern crate serde_derive;
+
+use std::process;
+use std::fs::{self, File};
+use std::io::{self, Write};
+use mdbook::renderer::RenderContext;
+use mdbook::book::{BookItem, Chapter};
+
+fn main() {
+    let mut stdin = io::stdin();
+    let ctx = RenderContext::from_json(&mut stdin).unwrap();
+    let cfg: WordcountConfig = ctx.config
+        .get_deserialized("output.wordcount")
+        .unwrap_or_default();
+
+    let _ = fs::create_dir_all(&ctx.destination);
+    let mut f = File::create(ctx.destination.join("wordcounts.txt")).unwrap();
+
+    for item in ctx.book.iter() {
+        if let BookItem::Chapter(ref ch) = *item {
+            if cfg.ignores.contains(&ch.name) {
+                continue;
+            }
+
+            let num_words = count_words(ch);
+            println!("{}: {}", ch.name, num_words);
+            writeln!(f, "{}: {}", ch.name, num_words).unwrap();
+
+            if cfg.deny_odds && num_words % 2 == 1 {
+                eprintln!("{} has an odd number of words!", ch.name);
+                process::exit(1);
+            }
+        }
+    }
+}
+
+fn count_words(ch: &Chapter) -> usize {
+    ch.content.split_whitespace().count()
+}
+
+#[derive(Debug, Default, Serialize, Deserialize)]
+#[serde(default, rename_all = "kebab-case")]
+pub struct WordcountConfig {
+    pub ignores: Vec<String>,
+    pub deny_odds: bool,
+}

guide/src/for_developers/preprocessors.md

@@ -0,0 +1,115 @@
+# Preprocessors
+
+A *preprocessor* is simply a bit of code which gets run immediately after the
+book is loaded and before it gets rendered, allowing you to update and mutate
+the book. Possible use cases are:
+
+- Creating custom helpers like `\{{#include /path/to/file.md}}`
+- Updating links so `[some chapter](some_chapter.md)` is automatically changed
+  to `[some chapter](some_chapter.html)` for the HTML renderer
+- Substituting in latex-style expressions (`$$ \frac{1}{3} $$`) with their
+  mathjax equivalents
+
+
+## Hooking Into MDBook
+
+MDBook uses a fairly simple mechanism for discovering third party plugins.
+A new table is added to `book.toml` (e.g. `preprocessor.foo` for the `foo`
+preprocessor) and then `mdbook` will try to invoke the `mdbook-foo` program as
+part of the build process.
+
+While preprocessors can be hard-coded to specify which backend it should be run
+for (e.g. it doesn't make sense for MathJax to be used for non-HTML renderers)
+with the `preprocessor.foo.renderer` key.
+
+```toml
+[book]
+title = "My Book"
+authors = ["Michael-F-Bryan"]
+
+[preprocessor.foo]
+# The command can also be specified manually
+command = "python3 /path/to/foo.py"
+# Only run the `foo` preprocessor for the HTML and EPUB renderer
+renderer = ["html", "epub"]
+```
+
+In typical unix style, all inputs to the plugin will be written to `stdin` as
+JSON and `mdbook` will read from `stdout` if it is expecting output.
+
+The easiest way to get started is by creating your own implementation of the
+`Preprocessor` trait (e.g. in `lib.rs`) and then creating a shell binary which
+translates inputs to the correct `Preprocessor` method. For convenience, there
+is [an example no-op preprocessor] in the `examples/` directory which can easily
+be adapted for other preprocessors.
+
+<details>
+<summary>Example no-op preprocessor</summary>
+
+```rust
+// nop-preprocessors.rs
+
+{{#include ../../../examples/nop-preprocessor.rs}}
+```
+</details>
+
+## Hints For Implementing A Preprocessor
+
+By pulling in `mdbook` as a library, preprocessors can have access to the
+existing infrastructure for dealing with books.
+
+For example, a custom preprocessor could use the
+[`CmdPreprocessor::parse_input()`] function to deserialize the JSON written to
+`stdin`. Then each chapter of the `Book` can be mutated in-place via
+[`Book::for_each_mut()`], and then written to `stdout` with the `serde_json`
+crate.
+
+Chapters can be accessed either directly (by recursively iterating over
+chapters) or via the `Book::for_each_mut()` convenience method.
+
+The `chapter.content` is just a string which happens to be markdown. While it's
+entirely possible to use regular expressions or do a manual find & replace,
+you'll probably want to process the input into something more computer-friendly.
+The [`pulldown-cmark`][pc] crate implements a production-quality event-based
+Markdown parser, with the [`pulldown-cmark-to-cmark`][pctc] allowing you to
+translate events back into markdown text.
+
+The following code block shows how to remove all emphasis from markdown,
+without accidentally breaking the document.
+
+```rust
+fn remove_emphasis(
+    num_removed_items: &mut usize,
+    chapter: &mut Chapter,
+) -> Result<String> {
+    let mut buf = String::with_capacity(chapter.content.len());
+
+    let events = Parser::new(&chapter.content).filter(|e| {
+        let should_keep = match *e {
+            Event::Start(Tag::Emphasis)
+            | Event::Start(Tag::Strong)
+            | Event::End(Tag::Emphasis)
+            | Event::End(Tag::Strong) => false,
+            _ => true,
+        };
+        if !should_keep {
+            *num_removed_items += 1;
+        }
+        should_keep
+    });
+
+    cmark(events, &mut buf, None).map(|_| buf).map_err(|err| {
+        Error::from(format!("Markdown serialization failed: {}", err))
+    })
+}
+```
+
+For everything else, have a look [at the complete example][example].
+
+[preprocessor-docs]: https://docs.rs/mdbook/latest/mdbook/preprocess/trait.Preprocessor.html
+[pc]: https://crates.io/crates/pulldown-cmark
+[pctc]: https://crates.io/crates/pulldown-cmark-to-cmark
+[example]: https://github.com/rust-lang/mdBook/blob/master/examples/nop-preprocessor.rs
+[an example no-op preprocessor]: https://github.com/rust-lang/mdBook/blob/master/examples/nop-preprocessor.rs
+[`CmdPreprocessor::parse_input()`]: https://docs.rs/mdbook/latest/mdbook/preprocess/trait.Preprocessor.html#method.parse_input
+[`Book::for_each_mut()`]: https://docs.rs/mdbook/latest/mdbook/book/struct.Book.html#method.for_each_mut

guide/src/format/config.md

@@ -0,0 +1,396 @@
+# Configuration
+
+You can configure the parameters for your book in the ***book.toml*** file.
+
+Here is an example of what a ***book.toml*** file might look like:
+
+```toml
+[book]
+title = "Example book"
+author = "John Doe"
+description = "The example book covers examples."
+
+[rust]
+edition = "2018"
+
+[build]
+build-dir = "my-example-book"
+create-missing = false
+
+[preprocessor.index]
+
+[preprocessor.links]
+
+[output.html]
+additional-css = ["custom.css"]
+
+[output.html.search]
+limit-results = 15
+```
+
+## Supported configuration options
+
+It is important to note that **any** relative path specified in the
+configuration will always be taken relative from the root of the book where the
+configuration file is located.
+
+### General metadata
+
+This is general information about your book.
+
+- **title:** The title of the book
+- **authors:** The author(s) of the book
+- **description:** A description for the book, which is added as meta
+  information in the html `<head>` of each page
+- **src:** By default, the source directory is found in the directory named
+  `src` directly under the root folder. But this is configurable with the `src`
+  key in the configuration file.
+- **language:** The main language of the book, which is used as a language attribute `<html lang="en">` for example.
+
+**book.toml**
+```toml
+[book]
+title = "Example book"
+authors = ["John Doe", "Jane Doe"]
+description = "The example book covers examples."
+src = "my-src"  # the source files will be found in `root/my-src` instead of `root/src`
+language = "en"
+```
+
+### Rust options
+
+Options for the Rust language, relevant to running tests and playground
+integration.
+
+- **edition**: Rust edition to use by default for the code snippets. Default
+  is "2015". Individual code blocks can be controlled with the `edition2015`
+  or `edition2018` annotations, such as:
+
+  ~~~text
+  ```rust,edition2015
+  // This only works in 2015.
+  let try = true;
+  ```
+  ~~~
+
+### Build options
+
+This controls the build process of your book.
+
+- **build-dir:** The directory to put the rendered book in. By default this is
+  `book/` in the book's root directory.
+- **create-missing:** By default, any missing files specified in `SUMMARY.md`
+  will be created when the book is built (i.e. `create-missing = true`). If this
+  is `false` then the build process will instead exit with an error if any files
+  do not exist.
+- **use-default-preprocessors:** Disable the default preprocessors of (`links` &
+  `index`) by setting this option to `false`.
+
+  If you have the same, and/or other preprocessors declared via their table
+  of configuration, they will run instead.
+
+  - For clarity, with no preprocessor configuration, the default `links` and
+    `index` will run.
+  - Setting `use-default-preprocessors = false` will disable these
+    default preprocessors from running.
+  - Adding `[preprocessor.links]`, for example, will ensure, regardless of
+    `use-default-preprocessors` that `links` it will run.
+
+## Configuring Preprocessors
+
+The following preprocessors are available and included by default:
+
+- `links`: Expand the `{{ #playground }}`, `{{ #include }}`, and `{{ #rustdoc_include }}` handlebars
+  helpers in a chapter to include the contents of a file.
+- `index`: Convert all chapter files named `README.md` into `index.md`. That is
+  to say, all `README.md` would be rendered to an index file `index.html` in the
+  rendered book.
+
+
+**book.toml**
+```toml
+[build]
+build-dir = "build"
+create-missing = false
+
+[preprocessor.links]
+
+[preprocessor.index]
+```
+
+### Custom Preprocessor Configuration
+
+Like renderers, preprocessor will need to be given its own table (e.g.
+`[preprocessor.mathjax]`). In the section, you may then pass extra
+configuration to the preprocessor by adding key-value pairs to the table.
+
+For example
+
+```toml
+[preprocessor.links]
+# set the renderers this preprocessor will run for
+renderers = ["html"]
+some_extra_feature = true
+```
+
+#### Locking a Preprocessor dependency to a renderer
+
+You can explicitly specify that a preprocessor should run for a renderer by
+binding the two together.
+
+```toml
+[preprocessor.mathjax]
+renderers = ["html"]  # mathjax only makes sense with the HTML renderer
+```
+
+### Provide Your Own Command
+
+By default when you add a `[preprocessor.foo]` table to your `book.toml` file,
+`mdbook` will try to invoke the `mdbook-foo` executable. If you want to use a
+different program name or pass in command-line arguments, this behaviour can
+be overridden by adding a `command` field.
+
+```toml
+[preprocessor.random]
+command = "python random.py"
+```
+
+## Configuring Renderers
+
+### HTML renderer options
+
+The HTML renderer has a couple of options as well. All the options for the
+renderer need to be specified under the TOML table `[output.html]`.
+
+The following configuration options are available:
+
+- **theme:** mdBook comes with a default theme and all the resource files needed
+  for it. But if this option is set, mdBook will selectively overwrite the theme
+  files with the ones found in the specified folder.
+- **default-theme:** The theme color scheme to select by default in the
+  'Change Theme' dropdown. Defaults to `light`.
+- **preferred-dark-theme:** The default dark theme. This theme will be used if
+  the browser requests the dark version of the site via the
+  ['prefers-color-scheme'](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
+  CSS media query. Defaults to `navy`.
+- **curly-quotes:** Convert straight quotes to curly quotes, except for those
+  that occur in code blocks and code spans. Defaults to `false`.
+- **mathjax-support:** Adds support for [MathJax](mathjax.md). Defaults to
+  `false`.
+- **copy-fonts:** Copies fonts.css and respective font files to the output directory and use them in the default theme. Defaults to `true`.
+- **google-analytics:** If you use Google Analytics, this option lets you enable
+  it by simply specifying your ID in the configuration file.
+- **additional-css:** If you need to slightly change the appearance of your book
+  without overwriting the whole style, you can specify a set of stylesheets that
+  will be loaded after the default ones where you can surgically change the
+  style.
+- **additional-js:** If you need to add some behaviour to your book without
+  removing the current behaviour, you can specify a set of JavaScript files that
+  will be loaded alongside the default one.
+- **print:** A subtable for configuration print settings. mdBook by default adds
+  support for printing out the book as a single page. This is accessed using the
+  print icon on the top right of the book.
+- **no-section-label:** mdBook by defaults adds section label in table of
+  contents column. For example, "1.", "2.1". Set this option to true to disable
+  those labels. Defaults to `false`.
+- **fold:** A subtable for configuring sidebar section-folding behavior.
+- **playground:** A subtable for configuring various playground settings.
+- **search:** A subtable for configuring the in-browser search functionality.
+  mdBook must be compiled with the `search` feature enabled (on by default).
+- **git-repository-url:**  A url to the git repository for the book. If provided
+  an icon link will be output in the menu bar of the book.
+- **git-repository-icon:** The FontAwesome icon class to use for the git
+  repository link. Defaults to `fa-github`.
+- **redirect:** A subtable used for generating redirects when a page is moved.
+  The table contains key-value pairs where the key is where the redirect file
+  needs to be created, as an absolute path from the build directory, (e.g.
+  `/appendices/bibliography.html`). The value can be any valid URI the
+  browser should navigate to (e.g. `https://rust-lang.org/`,
+  `/overview.html`, or `../bibliography.html`).
+- **input-404:** The name of the markdown file used for misssing files.
+  The corresponding output file will be the same, with the extension replaced with `html`.
+  Defaults to `404.md`.
+- **site-url:** The url where the book will be hosted. This is required to ensure
+  navigation links and script/css imports in the 404 file work correctly, even when accessing
+  urls in subdirectories. Defaults to `/`.
+- **cname:** The DNS subdomain or apex domain at which your book will be hosted.
+  This string will be written to a file named CNAME in the root of your site, as
+  required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages
+  site*][custom domain]).
+
+[custom domain]: https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site
+
+Available configuration options for the `[output.html.print]` table:
+
+- **enable:** Enable print support. When `false`, all print support will not be
+  rendered. Defaults to `true`.
+
+Available configuration options for the `[output.html.fold]` table:
+
+- **enable:** Enable section-folding. When off, all folds are open.
+  Defaults to `false`.
+- **level:** The higher the more folded regions are open. When level is 0, all
+  folds are closed. Defaults to `0`.
+
+Available configuration options for the `[output.html.playground]` table:
+
+- **editable:** Allow editing the source code. Defaults to `false`.
+- **copyable:** Display the copy button on code snippets. Defaults to `true`.
+- **copy-js:** Copy JavaScript files for the editor to the output directory.
+  Defaults to `true`.
+- **line-numbers** Display line numbers on editable sections of code. Requires both `editable` and `copy-js` to be `true`. Defaults to `false`.
+
+[Ace]: https://ace.c9.io/
+
+Available configuration options for the `[output.html.search]` table:
+
+- **enable:** Enables the search feature. Defaults to `true`.
+- **limit-results:** The maximum number of search results. Defaults to `30`.
+- **teaser-word-count:** The number of words used for a search result teaser.
+  Defaults to `30`.
+- **use-boolean-and:** Define the logical link between multiple search words. If
+  true, all search words must appear in each result. Defaults to `false`.
+- **boost-title:** Boost factor for the search result score if a search word
+  appears in the header. Defaults to `2`.
+- **boost-hierarchy:** Boost factor for the search result score if a search word
+  appears in the hierarchy. The hierarchy contains all titles of the parent
+  documents and all parent headings. Defaults to `1`.
+- **boost-paragraph:** Boost factor for the search result score if a search word
+  appears in the text. Defaults to `1`.
+- **expand:** True if search should match longer results e.g. search `micro`
+  should match `microwave`. Defaults to `true`.
+- **heading-split-level:** Search results will link to a section of the document
+  which contains the result. Documents are split into sections by headings this
+  level or less. Defaults to `3`. (`### This is a level 3 heading`)
+- **copy-js:** Copy JavaScript files for the search implementation to the output
+  directory. Defaults to `true`.
+
+This shows all available HTML output options in the **book.toml**:
+
+```toml
+[book]
+title = "Example book"
+authors = ["John Doe", "Jane Doe"]
+description = "The example book covers examples."
+
+[output.html]
+theme = "my-theme"
+default-theme = "light"
+preferred-dark-theme = "navy"
+curly-quotes = true
+mathjax-support = false
+copy-fonts = true
+google-analytics = "UA-123456-7"
+additional-css = ["custom.css", "custom2.css"]
+additional-js = ["custom.js"]
+no-section-label = false
+git-repository-url = "https://github.com/rust-lang/mdBook"
+git-repository-icon = "fa-github"
+site-url = "/example-book/"
+cname = "myproject.rs"
+input-404 = "not-found.md"
+
+[output.html.print]
+enable = true
+
+[output.html.fold]
+enable = false
+level = 0
+
+[output.html.playground]
+editable = false
+copy-js = true
+line-numbers = false
+
+[output.html.search]
+enable = true
+limit-results = 30
+teaser-word-count = 30
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 1
+boost-paragraph = 1
+expand = true
+heading-split-level = 3
+copy-js = true
+
+[output.html.redirect]
+"/appendices/bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
+"/other-installation-methods.html" = "../infra/other-installation-methods.html"
+```
+
+### Markdown Renderer
+
+The Markdown renderer will run preprocessors and then output the resulting
+Markdown. This is mostly useful for debugging preprocessors, especially in
+conjunction with `mdbook test` to see the Markdown that `mdbook` is passing
+to `rustdoc`.
+
+The Markdown renderer is included with `mdbook` but disabled by default.
+Enable it by adding an empty table to your `book.toml` as follows:
+
+```toml
+[output.markdown]
+```
+
+There are no configuration options for the Markdown renderer at this time;
+only whether it is enabled or disabled.
+
+See [the preprocessors documentation](#configuring-preprocessors) for how to
+specify which preprocessors should run before the Markdown renderer.
+
+### Custom Renderers
+
+A custom renderer can be enabled by adding a `[output.foo]` table to your
+`book.toml`. Similar to [preprocessors](#configuring-preprocessors) this will
+instruct `mdbook` to pass a representation of the book to `mdbook-foo` for
+rendering. See the [alternative backends] chapter for more detail.
+
+The custom renderer has access to all the fields within its table (i.e.
+anything under `[output.foo]`). mdBook checks for two common fields:
+
+- **command:** The command to execute for this custom renderer. Defaults to
+  the name of the renderer with the `mdbook-` prefix (such as `mdbook-foo`).
+- **optional:** If `true`, then the command will be ignored if it is not
+  installed, otherwise mdBook will fail with an error. Defaults to `false`.
+
+[alternative backends]: ../for_developers/backends.md
+
+## Environment Variables
+
+All configuration values can be overridden from the command line by setting the
+corresponding environment variable. Because many operating systems restrict
+environment variables to be alphanumeric characters or `_`, the configuration
+key needs to be formatted slightly differently to the normal `foo.bar.baz` form.
+
+Variables starting with `MDBOOK_` are used for configuration. The key is created
+by removing the `MDBOOK_` prefix and turning the resulting string into
+`kebab-case`. Double underscores (`__`) separate nested keys, while a single
+underscore (`_`) is replaced with a dash (`-`).
+
+For example:
+
+- `MDBOOK_foo` -> `foo`
+- `MDBOOK_FOO` -> `foo`
+- `MDBOOK_FOO__BAR` -> `foo.bar`
+- `MDBOOK_FOO_BAR` -> `foo-bar`
+- `MDBOOK_FOO_bar__baz` -> `foo-bar.baz`
+
+So by setting the `MDBOOK_BOOK__TITLE` environment variable you can override the
+book's title without needing to touch your `book.toml`.
+
+> **Note:** To facilitate setting more complex config items, the value of an
+> environment variable is first parsed as JSON, falling back to a string if the
+> parse fails.
+>
+> This means, if you so desired, you could override all book metadata when
+> building the book with something like
+>
+> ```shell
+> $ export MDBOOK_BOOK="{'title': 'My Awesome Book', authors: ['Michael-F-Bryan']}"
+> $ mdbook build
+> ```
+
+The latter case may be useful in situations where `mdbook` is invoked from a
+script or CI, where it sometimes isn't possible to update the `book.toml` before
+building.

guide/src/format/mathjax.md

@@ -0,0 +1,43 @@
+# MathJax Support
+
+mdBook has optional support for math equations through
+[MathJax](https://www.mathjax.org/).
+
+To enable MathJax, you need to add the `mathjax-support` key to your `book.toml`
+under the `output.html` section.
+
+```toml
+[output.html]
+mathjax-support = true
+```
+
+>**Note:** The usual delimiters MathJax uses are not yet supported. You can't
+currently use `$$ ... $$` as delimiters and the `\[ ... \]` delimiters need an
+extra backslash to work. Hopefully this limitation will be lifted soon.
+
+>**Note:** When you use double backslashes in MathJax blocks (for example in
+> commands such as `\begin{cases} \frac 1 2 \\ \frac 3 4 \end{cases}`) you need
+> to add _two extra_ backslashes (e.g., `\begin{cases} \frac 1 2 \\\\ \frac 3 4
+> \end{cases}`).
+
+
+### Inline equations
+Inline equations are delimited by `\\(` and `\\)`. So for example, to render the
+following inline equation \\( \int x dx = \frac{x^2}{2} + C \\) you would write
+the following:
+```
+\\( \int x dx = \frac{x^2}{2} + C \\)
+```
+
+### Block equations
+Block equations are delimited by `\\[` and `\\]`. To render the following
+equation
+
+\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\]
+
+
+you would write:
+
+```bash
+\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\]
+```

guide/src/format/mdbook.md

@@ -0,0 +1,194 @@
+# mdBook-specific features
+
+## Hiding code lines
+
+There is a feature in mdBook that lets you hide code lines by prepending them
+with a `#` [like you would with Rustdoc][rustdoc-hide].
+
+[rustdoc-hide]: https://doc.rust-lang.org/stable/rustdoc/documentation-tests.html#hiding-portions-of-the-example
+
+```bash
+# fn main() {
+    let x = 5;
+    let y = 6;
+
+    println!("{}", x + y);
+# }
+```
+
+Will render as
+
+```rust
+# fn main() {
+    let x = 5;
+    let y = 7;
+
+    println!("{}", x + y);
+# }
+```
+
+## Including files
+
+With the following syntax, you can include files into your book:
+
+```hbs
+\{{#include file.rs}}
+```
+
+The path to the file has to be relative from the current source file.
+
+mdBook will interpret included files as Markdown. Since the include command
+is usually used for inserting code snippets and examples, you will often
+wrap the command with ```` ``` ```` to display the file contents without
+interpretting them.
+
+````hbs
+```
+\{{#include file.rs}}
+```
+````
+
+## Including portions of a file
+Often you only need a specific part of the file e.g. relevant lines for an
+example. We support four different modes of partial includes:
+
+```hbs
+\{{#include file.rs:2}}
+\{{#include file.rs::10}}
+\{{#include file.rs:2:}}
+\{{#include file.rs:2:10}}
+```
+
+The first command only includes the second line from file `file.rs`. The second
+command includes all lines up to line 10, i.e. the lines from 11 till the end of
+the file are omitted. The third command includes all lines from line 2, i.e. the
+first line is omitted. The last command includes the excerpt of `file.rs`
+consisting of lines 2 to 10.
+
+To avoid breaking your book when modifying included files, you can also
+include a specific section using anchors instead of line numbers.
+An anchor is a pair of matching lines. The line beginning an anchor must
+match the regex "ANCHOR:\s*[\w_-]+" and similarly the ending line must match
+the regex "ANCHOR_END:\s*[\w_-]+". This allows you to put anchors in
+any kind of commented line.
+
+Consider the following file to include:
+```rs
+/* ANCHOR: all */
+
+// ANCHOR: component
+struct Paddle {
+    hello: f32,
+}
+// ANCHOR_END: component
+
+////////// ANCHOR: system
+impl System for MySystem { ... }
+////////// ANCHOR_END: system
+
+/* ANCHOR_END: all */
+```
+
+Then in the book, all you have to do is:
+````hbs
+Here is a component:
+```rust,no_run,noplayground
+\{{#include file.rs:component}}
+```
+
+Here is a system:
+```rust,no_run,noplayground
+\{{#include file.rs:system}}
+```
+
+This is the full file.
+```rust,no_run,noplayground
+\{{#include file.rs:all}}
+```
+````
+
+Lines containing anchor patterns inside the included anchor are ignored.
+
+## Including a file but initially hiding all except specified lines
+
+The `rustdoc_include` helper is for including code from external Rust files that contain complete
+examples, but only initially showing particular lines specified with line numbers or anchors in the
+same way as with `include`.
+
+The lines not in the line number range or between the anchors will still be included, but they will
+be prefaced with `#`. This way, a reader can expand the snippet to see the complete example, and
+Rustdoc will use the complete example when you run `mdbook test`.
+
+For example, consider a file named `file.rs` that contains this Rust program:
+
+```rust
+fn main() {
+    let x = add_one(2);
+    assert_eq!(x, 3);
+}
+
+fn add_one(num: i32) -> i32 {
+    num + 1
+}
+```
+
+We can include a snippet that initially shows only line 2 by using this syntax:
+
+````hbs
+To call the `add_one` function, we pass it an `i32` and bind the returned value to `x`:
+
+```rust
+\{{#rustdoc_include file.rs:2}}
+```
+````
+
+This would have the same effect as if we had manually inserted the code and hidden all but line 2
+using `#`:
+
+````hbs
+To call the `add_one` function, we pass it an `i32` and bind the returned value to `x`:
+
+```rust
+# fn main() {
+    let x = add_one(2);
+#     assert_eq!(x, 3);
+# }
+#
+# fn add_one(num: i32) -> i32 {
+#     num + 1
+#}
+```
+````
+
+That is, it looks like this (click the "expand" icon to see the rest of the file):
+
+```rust
+# fn main() {
+    let x = add_one(2);
+#     assert_eq!(x, 3);
+# }
+#
+# fn add_one(num: i32) -> i32 {
+#     num + 1
+#}
+```
+
+## Inserting runnable Rust files
+
+With the following syntax, you can insert runnable Rust files into your book:
+
+```hbs
+\{{#playground file.rs}}
+```
+
+The path to the Rust file has to be relative from the current source file.
+
+When play is clicked, the code snippet will be sent to the [Rust Playground] to be
+compiled and run. The result is sent back and displayed directly underneath the
+code.
+
+Here is what a rendered code snippet looks like:
+
+{{#playground example.rs}}
+
+[Rust Playground]: https://play.rust-lang.org/

guide/src/format/summary.md

@@ -0,0 +1,66 @@
+# SUMMARY.md
+
+The summary file is used by mdBook to know what chapters to include, in what
+order they should appear, what their hierarchy is and where the source files
+are. Without this file, there is no book.
+
+Even though `SUMMARY.md` is a markdown file, the formatting is very strict to
+allow for easy parsing. Let's see how you should format your `SUMMARY.md` file.
+
+#### Structure
+
+1. ***Title*** It's common practice to begin with a title, generally <code
+   class="language-markdown"># Summary</code>. But it is not mandatory, the
+   parser just ignores it. So you can too if you feel like it.
+
+2. ***Prefix Chapter*** Before the main numbered chapters you can add a couple
+   of elements that will not be numbered. This is useful for forewords,
+   introductions, etc. There are however some constraints. You can not nest
+   prefix chapters, they should all be on the root level. And you can not add
+   prefix chapters once you have added numbered chapters.
+   ```markdown
+   [Title of prefix element](relative/path/to/markdown.md)
+   ```
+
+3. ***Part Title:*** Headers can be used as a title for the following numbered
+   chapters. This can be used to logically separate different sections
+   of book. The title is rendered as unclickable text.
+   Titles are optional, and the numbered chapters can be broken into as many
+   parts as desired.
+
+4. ***Numbered Chapter*** Numbered chapters are the main content of the book,
+   they will be numbered and can be nested, resulting in a nice hierarchy
+   (chapters, sub-chapters, etc.)
+   ```markdown
+   # Title of Part
+
+   - [Title of the Chapter](relative/path/to/markdown.md)
+
+   # Title of Another Part
+
+   - [More Chapters](relative/path/to/markdown2.md)
+   ```
+   You can either use `-` or `*` to indicate a numbered chapter.
+
+5. ***Suffix Chapter*** After the numbered chapters you can add a couple of
+   non-numbered chapters. They are the same as prefix chapters but come after
+   the numbered chapters instead of before.
+
+All other elements are unsupported and will be ignored at best or result in an
+error.
+
+#### Other elements
+
+- ***Separators*** In between chapters you can add a separator. In the HTML renderer
+  this will result in a line being rendered in the table of contents. A separator is
+  a line containing exclusively dashes and at least three of them: `---`.
+- ***Draft chapters*** Draft chapters are chapters without a file and thus content.
+  The purpose of a draft chapter is to signal future chapters still to be written.
+  Or when still laying out the structure of the book to avoid creating the files
+  while you are still changing the structure of the book a lot.
+  Draft chapters will be rendered in the HTML renderer as disabled links in the table
+  of contents, as you can see for the next chapter in the table of contents on the left.
+  Draft chapters are written like normal chapters but without writing the path to the file
+  ```markdown
+  - [Draft chapter]()
+  ```

guide/src/format/theme/README.md

@@ -0,0 +1,44 @@
+# Theme
+
+The default renderer uses a [handlebars](http://handlebarsjs.com/) template to
+render your markdown files and comes with a default theme included in the mdBook
+binary.
+
+The theme is totally customizable, you can selectively replace every file from
+the theme by your own by adding a `theme` directory next to `src` folder in your
+project root. Create a new file with the name of the file you want to override
+and now that file will be used instead of the default file.
+
+Here are the files you can override:
+
+- **_index.hbs_** is the handlebars template.
+- **_head.hbs_** is appended to the HTML `<head>` section.
+- **_header.hbs_** content is appended on top of every book page.
+- **_book.css_** is the style used in the output. If you want to change the
+  design of your book, this is probably the file you want to modify. Sometimes
+  in conjunction with `index.hbs` when you want to radically change the layout.
+- **_book.js_** is mostly used to add client side functionality, like hiding /
+  un-hiding the sidebar, changing the theme, ...
+- **_highlight.js_** is the JavaScript that is used to highlight code snippets,
+  you should not need to modify this.
+- **_highlight.css_** is the theme used for the code highlighting.
+- **_favicon.svg_** and **_favicon.png_** the favicon that will be used. The SVG
+  version is used by [newer browsers].
+
+Generally, when you want to tweak the theme, you don't need to override all the
+files. If you only need changes in the stylesheet, there is no point in
+overriding all the other files. Because custom files take precedence over
+built-in ones, they will not get updated with new fixes / features.
+
+**Note:** When you override a file, it is possible that you break some
+functionality. Therefore I recommend to use the file from the default theme as
+template and only add / modify what you need. You can copy the default theme
+into your source directory automatically by using `mdbook init --theme` just
+remove the files you don't want to override.
+
+If you completely replace all built-in themes, be sure to also set
+[`output.html.preferred-dark-theme`] in the config, which defaults to the
+built-in `navy` theme.
+
+[`output.html.preferred-dark-theme`]: ../config.md#html-renderer-options
+[newer browsers]: https://caniuse.com/#feat=link-icon-svg

guide/src/format/theme/editor.md

@@ -0,0 +1,46 @@
+# Editor
+
+In addition to providing runnable code playgrounds, mdBook optionally allows them
+to be editable. In order to enable editable code blocks, the following needs to
+be added to the ***book.toml***:
+
+```toml
+[output.html.playground]
+editable = true
+```
+
+To make a specific block available for editing, the attribute `editable` needs
+to be added to it:
+
+<pre><code class="language-markdown">```rust,editable
+fn main() {
+    let number = 5;
+    print!("{}", number);
+}
+```</code></pre>
+
+The above will result in this editable playground:
+
+```rust,editable
+fn main() {
+    let number = 5;
+    print!("{}", number);
+}
+```
+
+Note the new `Undo Changes` button in the editable playgrounds.
+
+## Customizing the Editor
+
+By default, the editor is the [Ace](https://ace.c9.io/) editor, but, if desired,
+the functionality may be overriden by providing a different folder:
+
+```toml
+[output.html.playground]
+editable = true
+editor = "/path/to/editor"
+```
+
+Note that for the editor changes to function correctly, the `book.js` inside of
+the `theme` folder will need to be overriden as it has some couplings with the
+default Ace editor.

guide/src/format/theme/index-hbs.md

@@ -0,0 +1,101 @@
+# index.hbs
+
+`index.hbs` is the handlebars template that is used to render the book. The
+markdown files are processed to html and then injected in that template.
+
+If you want to change the layout or style of your book, chances are that you
+will have to modify this template a little bit. Here is what you need to know.
+
+## Data
+
+A lot of data is exposed to the handlebars template with the "context". In the
+handlebars template you can access this information by using
+
+```handlebars
+{{name_of_property}}
+```
+
+Here is a list of the properties that are exposed:
+
+- ***language*** Language of the book in the form `en`, as specified in `book.toml` (if not specified, defaults to `en`). To use in <code
+  class="language-html">\<html lang="{{ language }}"></code> for example.
+- ***title*** Title used for the current page. This is identical to `{{ book_title }} - {{ chapter_title }}` unless `book_title` is not set in which case it just defaults to the `chapter_title`.
+- ***book_title*** Title of the book, as specified in `book.toml`
+- ***chapter_title*** Title of the current chapter, as listed in `SUMMARY.md`
+
+- ***path*** Relative path to the original markdown file from the source
+  directory
+- ***content*** This is the rendered markdown.
+- ***path_to_root*** This is a path containing exclusively `../`'s that points
+  to the root of the book from the current file. Since the original directory
+  structure is maintained, it is useful to prepend relative links with this
+  `path_to_root`.
+
+- ***chapters*** Is an array of dictionaries of the form
+  ```json
+  {"section": "1.2.1", "name": "name of this chapter", "path": "dir/markdown.md"}
+  ```
+  containing all the chapters of the book. It is used for example to construct
+  the table of contents (sidebar).
+
+## Handlebars Helpers
+
+In addition to the properties you can access, there are some handlebars helpers
+at your disposal.
+
+### 1. toc
+
+The toc helper is used like this
+
+```handlebars
+{{#toc}}{{/toc}}
+```
+
+and outputs something that looks like this, depending on the structure of your
+book
+
+```html
+<ul class="chapter">
+    <li><a href="link/to/file.html">Some chapter</a></li>
+    <li>
+        <ul class="section">
+            <li><a href="link/to/other_file.html">Some other Chapter</a></li>
+        </ul>
+    </li>
+</ul>
+```
+
+If you would like to make a toc with another structure, you have access to the
+chapters property containing all the data. The only limitation at the moment
+is that you would have to do it with JavaScript instead of with a handlebars
+helper.
+
+```html
+<script>
+var chapters = {{chapters}};
+// Processing here
+</script>
+```
+
+### 2. previous / next
+
+The previous and next helpers expose a `link` and `name` property to the
+previous and next chapters.
+
+They are used like this
+
+```handlebars
+{{#previous}}
+    <a href="{{link}}" class="nav-chapters previous">
+        <i class="fa fa-angle-left"></i>
+    </a>
+{{/previous}}
+```
+
+The inner html will only be rendered if the previous / next chapter exists.
+Of course the inner html can be changed to your liking.
+
+------
+
+*If you would like other properties or helpers exposed, please [create a new
+issue](https://github.com/rust-lang/mdBook/issues)*

guide/src/format/theme/syntax-highlighting.md

@@ -0,0 +1,121 @@
+# Syntax Highlighting
+
+mdBook uses [Highlight.js](https://highlightjs.org) with a custom theme
+for syntax highlighting.
+
+Automatic language detection has been turned off, so you will probably want to
+specify the programming language you use like this:
+
+~~~markdown
+```rust
+fn main() {
+    // Some code
+}
+```
+~~~
+
+## Supported languages
+
+These languages are supported by default, but you can add more by supplying
+your own `highlight.js` file:
+
+- apache
+- armasm
+- bash
+- c
+- coffeescript
+- cpp
+- csharp
+- css
+- d
+- diff
+- go
+- handlebars
+- haskell
+- http
+- ini
+- java
+- javascript
+- json
+- julia
+- kotlin
+- less
+- lua
+- makefile
+- markdown
+- nginx
+- objectivec
+- perl
+- php
+- plaintext
+- properties
+- python
+- r
+- ruby
+- rust
+- scala
+- scss
+- shell
+- sql
+- swift
+- typescript
+- x86asm
+- xml
+- yaml
+
+## Custom theme
+Like the rest of the theme, the files used for syntax highlighting can be
+overridden with your own.
+
+- ***highlight.js*** normally you shouldn't have to overwrite this file, unless
+  you want to use a more recent version.
+- ***highlight.css*** theme used by highlight.js for syntax highlighting.
+
+If you want to use another theme for `highlight.js` download it from their
+website, or make it yourself, rename it to `highlight.css` and put it in
+the `theme` folder of your book.
+
+Now your theme will be used instead of the default theme.
+
+## Hiding code lines
+
+There is a feature in mdBook that lets you hide code lines by prepending them
+with a `#`.
+
+
+```bash
+# fn main() {
+    let x = 5;
+    let y = 6;
+
+    println!("{}", x + y);
+# }
+```
+
+Will render as
+
+```rust
+# fn main() {
+    let x = 5;
+    let y = 7;
+
+    println!("{}", x + y);
+# }
+```
+
+**At the moment, this only works for code examples that are annotated with
+`rust`. Because it would collide with semantics of some programming languages.
+In the future, we want to make this configurable through the `book.toml` so that
+everyone can benefit from it.**
+
+
+## Improve default theme
+
+If you think the default theme doesn't look quite right for a specific language,
+or could be improved. Feel free to [submit a new
+issue](https://github.com/rust-lang/mdBook/issues) explaining what you
+have in mind and I will take a look at it.
+
+You could also create a pull-request with the proposed improvements.
+
+Overall the theme should be light and sober, without to many flashy colors.

guide/src/misc/contributors.md

@@ -1,8 +1,7 @@
 # Contributors
 
-Here is a list of the contributors who have helped improving mdBook. Big shout-out to them!
-
-If you have contributed to mdBook and I forgot to add you, don't hesitate to add yourself to the list. If you are in the list, feel free to add your real name & contact information if you wish.
+Here is a list of the contributors who have helped improving mdBook. Big
+shout-out to them!
 
 - [mdinger](https://github.com/mdinger)
 - Kevin ([kbknapp](https://github.com/kbknapp))
@@ -11,3 +10,11 @@ If you have contributed to mdBook and I forgot to add you, don't hesitate to add
 - Wayne Nilsen ([waynenilsen](https://github.com/waynenilsen))
 - [funnkill](https://github.com/funkill)
 - Fu Gangqiang ([FuGangqiang](https://github.com/FuGangqiang))
+- [Michael-F-Bryan](https://github.com/Michael-F-Bryan)
+- Chris Spiegel ([cspiegel](https://github.com/cspiegel))
+- [projektir](https://github.com/projektir)
+- [Phaiax](https://github.com/Phaiax)
+- Matt Ickstadt ([mattico](https://github.com/mattico))
+- Weihang Lo ([@weihanglo](https://github.com/weihanglo))
+
+If you feel you're missing from this list, feel free to add yourself in a PR.

release.toml

@@ -0,0 +1,3 @@
+sign-commit = true
+push-remote = "origin"
+tag-prefix = "v"

rustfmt.toml

@@ -1,15 +0,0 @@
-write_mode = "Overwrite"
-
-max_width = 120
-ideal_width = 120
-fn_call_width = 100
-
-fn_args_density = "Compressed"
-
-enum_trailing_comma = true
-match_block_trailing_comma = true
-struct_trailing_comma = "Always"
-wrap_comments = true
-
-report_todo = "Always"
-report_fixme = "Always"

src/bin/mdbook.rs

@@ -1,380 +0,0 @@
-extern crate mdbook;
-#[macro_use]
-extern crate clap;
-extern crate log;
-extern crate env_logger;
-extern crate open;
-
-// Dependencies for the Watch feature
-#[cfg(feature = "watch")]
-extern crate notify;
-#[cfg(feature = "watch")]
-extern crate time;
-#[cfg(feature = "watch")]
-extern crate crossbeam;
-
-// Dependencies for the Serve feature
-#[cfg(feature = "serve")]
-extern crate iron;
-#[cfg(feature = "serve")]
-extern crate staticfile;
-#[cfg(feature = "serve")]
-extern crate ws;
-
-use std::env;
-use std::error::Error;
-use std::ffi::OsStr;
-use std::io::{self, Write};
-use std::path::{Path, PathBuf};
-
-use clap::{App, ArgMatches, SubCommand, AppSettings};
-
-// Uses for the Watch feature
-#[cfg(feature = "watch")]
-use notify::Watcher;
-#[cfg(feature = "watch")]
-use std::time::Duration;
-#[cfg(feature = "watch")]
-use std::sync::mpsc::channel;
-
-
-use mdbook::MDBook;
-
-const NAME: &'static str = "mdbook";
-
-fn main() {
-    env_logger::init().unwrap();
-
-    // Create a list of valid arguments and sub-commands
-    let matches = App::new(NAME)
-                    .about("Create a book in form of a static website from markdown files")
-                    .author("Mathieu David <mathieudavid@mathieudavid.org>")
-                    // Get the version from our Cargo.toml using clap's crate_version!() macro
-                    .version(&*format!("v{}", crate_version!()))
-                    .setting(AppSettings::SubcommandRequired)
-                    .after_help("For more information about a specific command, try `mdbook <command> --help`\nSource code for mdbook available at: https://github.com/azerupi/mdBook")
-                    .subcommand(SubCommand::with_name("init")
-                        .about("Create boilerplate structure and files in the directory")
-                        // the {n} denotes a newline which will properly aligned in all help messages
-                        .arg_from_usage("[dir] 'A directory for your book{n}(Defaults to Current Directory when omitted)'")
-                        .arg_from_usage("--theme 'Copies the default theme into your source folder'")
-                        .arg_from_usage("--force 'skip confirmation prompts'"))
-                    .subcommand(SubCommand::with_name("build")
-                        .about("Build the book from the markdown files")
-                        .arg_from_usage("-o, --open 'Open the compiled book in a web browser'")
-                        .arg_from_usage("-d, --dest-dir=[dest-dir] 'The output directory for your book{n}(Defaults to ./book when omitted)'")
-                        .arg_from_usage("--no-create 'Will not create non-existent files linked from SUMMARY.md'")
-                        .arg_from_usage("[dir] 'A directory for your book{n}(Defaults to Current Directory when omitted)'"))
-                    .subcommand(SubCommand::with_name("watch")
-                        .about("Watch the files for changes")
-                        .arg_from_usage("-o, --open 'Open the compiled book in a web browser'")
-                        .arg_from_usage("-d, --dest-dir=[dest-dir] 'The output directory for your book{n}(Defaults to ./book when omitted)'")
-                        .arg_from_usage("[dir] 'A directory for your book{n}(Defaults to Current Directory when omitted)'"))
-                    .subcommand(SubCommand::with_name("serve")
-                        .about("Serve the book at http://localhost:3000. Rebuild and reload on change.")
-                        .arg_from_usage("[dir] 'A directory for your book{n}(Defaults to Current Directory when omitted)'")
-                        .arg_from_usage("-d, --dest-dir=[dest-dir] 'The output directory for your book{n}(Defaults to ./book when omitted)'")
-                        .arg_from_usage("-p, --port=[port] 'Use another port{n}(Defaults to 3000)'")
-                        .arg_from_usage("-w, --websocket-port=[ws-port] 'Use another port for the websocket connection (livereload){n}(Defaults to 3001)'")
-                        .arg_from_usage("-i, --interface=[interface] 'Interface to listen on{n}(Defaults to localhost)'")
-                        .arg_from_usage("-a, --address=[address] 'Address that the browser can reach the websocket server from{n}(Defaults to the interface address)'")
-                        .arg_from_usage("-o, --open 'Open the book server in a web browser'"))
-                    .subcommand(SubCommand::with_name("test")
-                        .about("Test that code samples compile"))
-                    .get_matches();
-
-    // Check which subcomamnd the user ran...
-    let res = match matches.subcommand() {
-        ("init", Some(sub_matches)) => init(sub_matches),
-        ("build", Some(sub_matches)) => build(sub_matches),
-        #[cfg(feature = "watch")]
-        ("watch", Some(sub_matches)) => watch(sub_matches),
-        #[cfg(feature = "serve")]
-        ("serve", Some(sub_matches)) => serve(sub_matches),
-        ("test", Some(sub_matches)) => test(sub_matches),
-        (_, _) => unreachable!(),
-    };
-
-    if let Err(e) = res {
-        writeln!(&mut io::stderr(), "An error occured:\n{}", e).ok();
-        ::std::process::exit(101);
-    }
-}
-
-
-// Simple function that user comfirmation
-fn confirm() -> bool {
-    io::stdout().flush().unwrap();
-    let mut s = String::new();
-    io::stdin().read_line(&mut s).ok();
-    match &*s.trim() {
-        "Y" | "y" | "yes" | "Yes" => true,
-        _ => false,
-    }
-}
-
-
-// Init command implementation
-fn init(args: &ArgMatches) -> Result<(), Box<Error>> {
-
-    let book_dir = get_book_dir(args);
-    let mut book = MDBook::new(&book_dir);
-
-    // Call the function that does the initialization
-    try!(book.init());
-
-    // If flag `--theme` is present, copy theme to src
-    if args.is_present("theme") {
-
-        // Skip this if `--force` is present
-        if !args.is_present("force") {
-            // Print warning
-            print!("\nCopying the default theme to {:?}", book.get_src());
-            println!("could potentially overwrite files already present in that directory.");
-            print!("\nAre you sure you want to continue? (y/n) ");
-
-            // Read answer from user and exit if it's not 'yes'
-            if !confirm() {
-                println!("\nSkipping...\n");
-                println!("All done, no errors...");
-                ::std::process::exit(0);
-            }
-        }
-
-        // Call the function that copies the theme
-        try!(book.copy_theme());
-        println!("\nTheme copied.");
-
-    }
-
-    // Because of `src/book/mdbook.rs#L37-L39`, `dest` will always start with `root`
-    let is_dest_inside_root = book.get_dest().starts_with(book.get_root());
-
-    if !args.is_present("force") && is_dest_inside_root {
-        println!("\nDo you want a .gitignore to be created? (y/n)");
-
-        if confirm() {
-            book.create_gitignore();
-            println!("\n.gitignore created.");
-        }
-    }
-
-    println!("\nAll done, no errors...");
-
-    Ok(())
-}
-
-
-// Build command implementation
-fn build(args: &ArgMatches) -> Result<(), Box<Error>> {
-    let book_dir = get_book_dir(args);
-    let book = MDBook::new(&book_dir).read_config();
-
-    let mut book = match args.value_of("dest-dir") {
-        Some(dest_dir) => book.set_dest(Path::new(dest_dir)),
-        None => book
-    };
-
-    if args.is_present("no-create") {
-        book.create_missing = false;
-    }
-
-    try!(book.build());
-
-    if args.is_present("open") {
-        open(book.get_dest().join("index.html"));
-    }
-
-    Ok(())
-}
-
-
-// Watch command implementation
-#[cfg(feature = "watch")]
-fn watch(args: &ArgMatches) -> Result<(), Box<Error>> {
-    let book_dir = get_book_dir(args);
-    let book = MDBook::new(&book_dir).read_config();
-
-    let mut book = match args.value_of("dest-dir") {
-        Some(dest_dir) => book.set_dest(Path::new(dest_dir)),
-        None => book
-    };
-
-    if args.is_present("open") {
-        try!(book.build());
-        open(book.get_dest().join("index.html"));
-    }
-
-    trigger_on_change(&mut book, |path, book| {
-        println!("File changed: {:?}\nBuilding book...\n", path);
-        if let Err(e) = book.build() {
-            println!("Error while building: {:?}", e);
-        }
-        println!("");
-    });
-
-    Ok(())
-}
-
-
-// Watch command implementation
-#[cfg(feature = "serve")]
-fn serve(args: &ArgMatches) -> Result<(), Box<Error>> {
-    const RELOAD_COMMAND: &'static str = "reload";
-
-    let book_dir = get_book_dir(args);
-    let book = MDBook::new(&book_dir).read_config();
-
-    let mut book = match args.value_of("dest-dir") {
-        Some(dest_dir) => book.set_dest(Path::new(dest_dir)),
-        None => book
-    };
-
-    let port = args.value_of("port").unwrap_or("3000");
-    let ws_port = args.value_of("ws-port").unwrap_or("3001");
-    let interface = args.value_of("interface").unwrap_or("localhost");
-    let public_address = args.value_of("address").unwrap_or(interface);
-    let open_browser = args.is_present("open");
-
-    let address = format!("{}:{}", interface, port);
-    let ws_address = format!("{}:{}", interface, ws_port);
-
-    book.set_livereload(format!(r#"
-        <script type="text/javascript">
-            var socket = new WebSocket("ws://{}:{}");
-            socket.onmessage = function (event) {{
-                if (event.data === "{}") {{
-                    socket.close();
-                    location.reload(true); // force reload from server (not from cache)
-                }}
-            }};
-
-            window.onbeforeunload = function() {{
-                socket.close();
-            }}
-        </script>
-    "#, public_address, ws_port, RELOAD_COMMAND).to_owned());
-
-    try!(book.build());
-
-    let staticfile = staticfile::Static::new(book.get_dest());
-    let iron = iron::Iron::new(staticfile);
-    let _iron = iron.http(&*address).unwrap();
-
-    let ws_server = ws::WebSocket::new(|_| {
-        |_| {
-            Ok(())
-        }
-    }).unwrap();
-
-    let broadcaster = ws_server.broadcaster();
-
-    std::thread::spawn(move || {
-        ws_server.listen(&*ws_address).unwrap();
-    });
-
-    println!("\nServing on {}", address);
-
-    if open_browser {
-        open(format!("http://{}", address));
-    }
-
-    trigger_on_change(&mut book, move |path, book| {
-        println!("File changed: {:?}\nBuilding book...\n", path);
-        match book.build() {
-            Err(e) => println!("Error while building: {:?}", e),
-            _ => broadcaster.send(RELOAD_COMMAND).unwrap(),
-        }
-        println!("");
-    });
-
-    Ok(())
-}
-
-
-fn test(args: &ArgMatches) -> Result<(), Box<Error>> {
-    let book_dir = get_book_dir(args);
-    let mut book = MDBook::new(&book_dir).read_config();
-
-    try!(book.test());
-
-    Ok(())
-}
-
-
-fn get_book_dir(args: &ArgMatches) -> PathBuf {
-    if let Some(dir) = args.value_of("dir") {
-        // Check if path is relative from current dir, or absolute...
-        let p = Path::new(dir);
-        if p.is_relative() {
-            env::current_dir().unwrap().join(dir)
-        } else {
-            p.to_path_buf()
-        }
-    } else {
-        env::current_dir().unwrap()
-    }
-}
-
-fn open<P: AsRef<OsStr>>(path: P) {
-    if let Err(e) = open::that(path) {
-        println!("Error opening web browser: {}", e);
-    }
-}
-
-
-// Calls the closure when a book source file is changed. This is blocking!
-#[cfg(feature = "watch")]
-fn trigger_on_change<F>(book: &mut MDBook, closure: F) -> ()
-    where F: Fn(&Path, &mut MDBook) -> ()
-{
-    use notify::RecursiveMode::*;
-    use notify::DebouncedEvent::*;
-
-    // Create a channel to receive the events.
-    let (tx, rx) = channel();
-
-    let mut watcher = match notify::watcher(tx, Duration::from_secs(1)) {
-        Ok(w) => w,
-        Err(e) => {
-            println!("Error while trying to watch the files:\n\n\t{:?}", e);
-            ::std::process::exit(0);
-        }
-    };
-
-    // Add the source directory to the watcher
-    if let Err(e) = watcher.watch(book.get_src(), Recursive) {
-        println!("Error while watching {:?}:\n    {:?}", book.get_src(), e);
-        ::std::process::exit(0);
-    };
-
-    // Add the book.{json,toml} file to the watcher if it exists, because it's not
-    // located in the source directory
-    if watcher.watch(book.get_root().join("book.json"), NonRecursive).is_err() {
-        // do nothing if book.json is not found
-    }
-    if watcher.watch(book.get_root().join("book.toml"), NonRecursive).is_err() {
-        // do nothing if book.toml is not found
-    }
-
-    println!("\nListening for changes...\n");
-
-    loop {
-        match rx.recv() {
-            Ok(event) => match event {
-                NoticeWrite(path) |
-                NoticeRemove(path) |
-                Create(path) |
-                Write(path) |
-                Remove(path) |
-                Rename(_, path) => {
-                    closure(&path, book);
-                }
-                _ => {}
-            },
-            Err(e) => {
-                println!("An error occured: {:?}", e);
-            },
-        }
-    }
-}

src/book/book.rs

@@ -0,0 +1,602 @@
+use std::collections::VecDeque;
+use std::fmt::{self, Display, Formatter};
+use std::fs::{self, File};
+use std::io::{Read, Write};
+use std::path::{Path, PathBuf};
+
+use super::summary::{parse_summary, Link, SectionNumber, Summary, SummaryItem};
+use crate::config::BuildConfig;
+use crate::errors::*;
+
+/// Load a book into memory from its `src/` directory.
+pub fn load_book<P: AsRef<Path>>(src_dir: P, cfg: &BuildConfig) -> Result<Book> {
+    let src_dir = src_dir.as_ref();
+    let summary_md = src_dir.join("SUMMARY.md");
+
+    let mut summary_content = String::new();
+    File::open(summary_md)
+        .with_context(|| "Couldn't open SUMMARY.md")?
+        .read_to_string(&mut summary_content)?;
+
+    let summary = parse_summary(&summary_content).with_context(|| "Summary parsing failed")?;
+
+    if cfg.create_missing {
+        create_missing(&src_dir, &summary).with_context(|| "Unable to create missing chapters")?;
+    }
+
+    load_book_from_disk(&summary, src_dir)
+}
+
+fn create_missing(src_dir: &Path, summary: &Summary) -> Result<()> {
+    let mut items: Vec<_> = summary
+        .prefix_chapters
+        .iter()
+        .chain(summary.numbered_chapters.iter())
+        .chain(summary.suffix_chapters.iter())
+        .collect();
+
+    while !items.is_empty() {
+        let next = items.pop().expect("already checked");
+
+        if let SummaryItem::Link(ref link) = *next {
+            if let Some(ref location) = link.location {
+                let filename = src_dir.join(location);
+                if !filename.exists() {
+                    if let Some(parent) = filename.parent() {
+                        if !parent.exists() {
+                            fs::create_dir_all(parent)?;
+                        }
+                    }
+                    debug!("Creating missing file {}", filename.display());
+
+                    let mut f = File::create(&filename)?;
+                    writeln!(f, "# {}", link.name)?;
+                }
+            }
+
+            items.extend(&link.nested_items);
+        }
+    }
+
+    Ok(())
+}
+
+/// A dumb tree structure representing a book.
+///
+/// For the moment a book is just a collection of `BookItems` which are
+/// accessible by either iterating (immutably) over the book with [`iter()`], or
+/// recursively applying a closure to each section to mutate the chapters, using
+/// [`for_each_mut()`].
+///
+/// [`iter()`]: #method.iter
+/// [`for_each_mut()`]: #method.for_each_mut
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
+pub struct Book {
+    /// The sections in this book.
+    pub sections: Vec<BookItem>,
+    __non_exhaustive: (),
+}
+
+impl Book {
+    /// Create an empty book.
+    pub fn new() -> Self {
+        Default::default()
+    }
+
+    /// Get a depth-first iterator over the items in the book.
+    pub fn iter(&self) -> BookItems<'_> {
+        BookItems {
+            items: self.sections.iter().collect(),
+        }
+    }
+
+    /// Recursively apply a closure to each item in the book, allowing you to
+    /// mutate them.
+    ///
+    /// # Note
+    ///
+    /// Unlike the `iter()` method, this requires a closure instead of returning
+    /// an iterator. This is because using iterators can possibly allow you
+    /// to have iterator invalidation errors.
+    pub fn for_each_mut<F>(&mut self, mut func: F)
+    where
+        F: FnMut(&mut BookItem),
+    {
+        for_each_mut(&mut func, &mut self.sections);
+    }
+
+    /// Append a `BookItem` to the `Book`.
+    pub fn push_item<I: Into<BookItem>>(&mut self, item: I) -> &mut Self {
+        self.sections.push(item.into());
+        self
+    }
+}
+
+pub fn for_each_mut<'a, F, I>(func: &mut F, items: I)
+where
+    F: FnMut(&mut BookItem),
+    I: IntoIterator<Item = &'a mut BookItem>,
+{
+    for item in items {
+        if let BookItem::Chapter(ch) = item {
+            for_each_mut(func, &mut ch.sub_items);
+        }
+
+        func(item);
+    }
+}
+
+/// Enum representing any type of item which can be added to a book.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub enum BookItem {
+    /// A nested chapter.
+    Chapter(Chapter),
+    /// A section separator.
+    Separator,
+    /// A part title.
+    PartTitle(String),
+}
+
+impl From<Chapter> for BookItem {
+    fn from(other: Chapter) -> BookItem {
+        BookItem::Chapter(other)
+    }
+}
+
+/// The representation of a "chapter", usually mapping to a single file on
+/// disk however it may contain multiple sub-chapters.
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
+pub struct Chapter {
+    /// The chapter's name.
+    pub name: String,
+    /// The chapter's contents.
+    pub content: String,
+    /// The chapter's section number, if it has one.
+    pub number: Option<SectionNumber>,
+    /// Nested items.
+    pub sub_items: Vec<BookItem>,
+    /// The chapter's location, relative to the `SUMMARY.md` file.
+    pub path: Option<PathBuf>,
+    /// An ordered list of the names of each chapter above this one, in the hierarchy.
+    pub parent_names: Vec<String>,
+}
+
+impl Chapter {
+    /// Create a new chapter with the provided content.
+    pub fn new<P: Into<PathBuf>>(
+        name: &str,
+        content: String,
+        path: P,
+        parent_names: Vec<String>,
+    ) -> Chapter {
+        Chapter {
+            name: name.to_string(),
+            content,
+            path: Some(path.into()),
+            parent_names,
+            ..Default::default()
+        }
+    }
+
+    /// Create a new draft chapter that is not attached to a source markdown file and has
+    /// thus no content.
+    pub fn new_draft(name: &str, parent_names: Vec<String>) -> Self {
+        Chapter {
+            name: name.to_string(),
+            content: String::new(),
+            path: None,
+            parent_names,
+            ..Default::default()
+        }
+    }
+
+    /// Check if the chapter is a draft chapter, meaning it has no path to a source markdown file
+    pub fn is_draft_chapter(&self) -> bool {
+        match self.path {
+            Some(_) => false,
+            None => true,
+        }
+    }
+}
+
+/// Use the provided `Summary` to load a `Book` from disk.
+///
+/// You need to pass in the book's source directory because all the links in
+/// `SUMMARY.md` give the chapter locations relative to it.
+pub(crate) fn load_book_from_disk<P: AsRef<Path>>(summary: &Summary, src_dir: P) -> Result<Book> {
+    debug!("Loading the book from disk");
+    let src_dir = src_dir.as_ref();
+
+    let prefix = summary.prefix_chapters.iter();
+    let numbered = summary.numbered_chapters.iter();
+    let suffix = summary.suffix_chapters.iter();
+
+    let summary_items = prefix.chain(numbered).chain(suffix);
+
+    let mut chapters = Vec::new();
+
+    for summary_item in summary_items {
+        let chapter = load_summary_item(summary_item, src_dir, Vec::new())?;
+        chapters.push(chapter);
+    }
+
+    Ok(Book {
+        sections: chapters,
+        __non_exhaustive: (),
+    })
+}
+
+fn load_summary_item<P: AsRef<Path> + Clone>(
+    item: &SummaryItem,
+    src_dir: P,
+    parent_names: Vec<String>,
+) -> Result<BookItem> {
+    match item {
+        SummaryItem::Separator => Ok(BookItem::Separator),
+        SummaryItem::Link(ref link) => {
+            load_chapter(link, src_dir, parent_names).map(BookItem::Chapter)
+        }
+        SummaryItem::PartTitle(title) => Ok(BookItem::PartTitle(title.clone())),
+    }
+}
+
+fn load_chapter<P: AsRef<Path>>(
+    link: &Link,
+    src_dir: P,
+    parent_names: Vec<String>,
+) -> Result<Chapter> {
+    let src_dir = src_dir.as_ref();
+
+    let mut ch = if let Some(ref link_location) = link.location {
+        debug!("Loading {} ({})", link.name, link_location.display());
+
+        let location = if link_location.is_absolute() {
+            link_location.clone()
+        } else {
+            src_dir.join(link_location)
+        };
+
+        let mut f = File::open(&location)
+            .with_context(|| format!("Chapter file not found, {}", link_location.display()))?;
+
+        let mut content = String::new();
+        f.read_to_string(&mut content).with_context(|| {
+            format!("Unable to read \"{}\" ({})", link.name, location.display())
+        })?;
+
+        let stripped = location
+            .strip_prefix(&src_dir)
+            .expect("Chapters are always inside a book");
+
+        Chapter::new(&link.name, content, stripped, parent_names.clone())
+    } else {
+        Chapter::new_draft(&link.name, parent_names.clone())
+    };
+
+    let mut sub_item_parents = parent_names.clone();
+
+    ch.number = link.number.clone();
+
+    sub_item_parents.push(link.name.clone());
+    let sub_items = link
+        .nested_items
+        .iter()
+        .map(|i| load_summary_item(i, src_dir, sub_item_parents.clone()))
+        .collect::<Result<Vec<_>>>()?;
+
+    ch.sub_items = sub_items;
+
+    Ok(ch)
+}
+
+/// A depth-first iterator over the items in a book.
+///
+/// # Note
+///
+/// This struct shouldn't be created directly, instead prefer the
+/// [`Book::iter()`] method.
+///
+/// [`Book::iter()`]: struct.Book.html#method.iter
+pub struct BookItems<'a> {
+    items: VecDeque<&'a BookItem>,
+}
+
+impl<'a> Iterator for BookItems<'a> {
+    type Item = &'a BookItem;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let item = self.items.pop_front();
+
+        if let Some(&BookItem::Chapter(ref ch)) = item {
+            // if we wanted a breadth-first iterator we'd `extend()` here
+            for sub_item in ch.sub_items.iter().rev() {
+                self.items.push_front(sub_item);
+            }
+        }
+
+        item
+    }
+}
+
+impl Display for Chapter {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        if let Some(ref section_number) = self.number {
+            write!(f, "{} ", section_number)?;
+        }
+
+        write!(f, "{}", self.name)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::io::Write;
+    use tempfile::{Builder as TempFileBuilder, TempDir};
+
+    const DUMMY_SRC: &str = "
+# Dummy Chapter
+
+this is some dummy text.
+
+And here is some \
+                                     more text.
+";
+
+    /// Create a dummy `Link` in a temporary directory.
+    fn dummy_link() -> (Link, TempDir) {
+        let temp = TempFileBuilder::new().prefix("book").tempdir().unwrap();
+
+        let chapter_path = temp.path().join("chapter_1.md");
+        File::create(&chapter_path)
+            .unwrap()
+            .write_all(DUMMY_SRC.as_bytes())
+            .unwrap();
+
+        let link = Link::new("Chapter 1", chapter_path);
+
+        (link, temp)
+    }
+
+    /// Create a nested `Link` written to a temporary directory.
+    fn nested_links() -> (Link, TempDir) {
+        let (mut root, temp_dir) = dummy_link();
+
+        let second_path = temp_dir.path().join("second.md");
+
+        File::create(&second_path)
+            .unwrap()
+            .write_all(b"Hello World!")
+            .unwrap();
+
+        let mut second = Link::new("Nested Chapter 1", &second_path);
+        second.number = Some(SectionNumber(vec![1, 2]));
+
+        root.nested_items.push(second.clone().into());
+        root.nested_items.push(SummaryItem::Separator);
+        root.nested_items.push(second.clone().into());
+
+        (root, temp_dir)
+    }
+
+    #[test]
+    fn load_a_single_chapter_from_disk() {
+        let (link, temp_dir) = dummy_link();
+        let should_be = Chapter::new(
+            "Chapter 1",
+            DUMMY_SRC.to_string(),
+            "chapter_1.md",
+            Vec::new(),
+        );
+
+        let got = load_chapter(&link, temp_dir.path(), Vec::new()).unwrap();
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn cant_load_a_nonexistent_chapter() {
+        let link = Link::new("Chapter 1", "/foo/bar/baz.md");
+
+        let got = load_chapter(&link, "", Vec::new());
+        assert!(got.is_err());
+    }
+
+    #[test]
+    fn load_recursive_link_with_separators() {
+        let (root, temp) = nested_links();
+
+        let nested = Chapter {
+            name: String::from("Nested Chapter 1"),
+            content: String::from("Hello World!"),
+            number: Some(SectionNumber(vec![1, 2])),
+            path: Some(PathBuf::from("second.md")),
+            parent_names: vec![String::from("Chapter 1")],
+            sub_items: Vec::new(),
+        };
+        let should_be = BookItem::Chapter(Chapter {
+            name: String::from("Chapter 1"),
+            content: String::from(DUMMY_SRC),
+            number: None,
+            path: Some(PathBuf::from("chapter_1.md")),
+            parent_names: Vec::new(),
+            sub_items: vec![
+                BookItem::Chapter(nested.clone()),
+                BookItem::Separator,
+                BookItem::Chapter(nested.clone()),
+            ],
+        });
+
+        let got = load_summary_item(&SummaryItem::Link(root), temp.path(), Vec::new()).unwrap();
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn load_a_book_with_a_single_chapter() {
+        let (link, temp) = dummy_link();
+        let summary = Summary {
+            numbered_chapters: vec![SummaryItem::Link(link)],
+            ..Default::default()
+        };
+        let should_be = Book {
+            sections: vec![BookItem::Chapter(Chapter {
+                name: String::from("Chapter 1"),
+                content: String::from(DUMMY_SRC),
+                path: Some(PathBuf::from("chapter_1.md")),
+                ..Default::default()
+            })],
+            ..Default::default()
+        };
+
+        let got = load_book_from_disk(&summary, temp.path()).unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn book_iter_iterates_over_sequential_items() {
+        let book = Book {
+            sections: vec![
+                BookItem::Chapter(Chapter {
+                    name: String::from("Chapter 1"),
+                    content: String::from(DUMMY_SRC),
+                    ..Default::default()
+                }),
+                BookItem::Separator,
+            ],
+            ..Default::default()
+        };
+
+        let should_be: Vec<_> = book.sections.iter().collect();
+
+        let got: Vec<_> = book.iter().collect();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn iterate_over_nested_book_items() {
+        let book = Book {
+            sections: vec![
+                BookItem::Chapter(Chapter {
+                    name: String::from("Chapter 1"),
+                    content: String::from(DUMMY_SRC),
+                    number: None,
+                    path: Some(PathBuf::from("Chapter_1/index.md")),
+                    parent_names: Vec::new(),
+                    sub_items: vec![
+                        BookItem::Chapter(Chapter::new(
+                            "Hello World",
+                            String::new(),
+                            "Chapter_1/hello.md",
+                            Vec::new(),
+                        )),
+                        BookItem::Separator,
+                        BookItem::Chapter(Chapter::new(
+                            "Goodbye World",
+                            String::new(),
+                            "Chapter_1/goodbye.md",
+                            Vec::new(),
+                        )),
+                    ],
+                }),
+                BookItem::Separator,
+            ],
+            ..Default::default()
+        };
+
+        let got: Vec<_> = book.iter().collect();
+
+        assert_eq!(got.len(), 5);
+
+        // checking the chapter names are in the order should be sufficient here...
+        let chapter_names: Vec<String> = got
+            .into_iter()
+            .filter_map(|i| match *i {
+                BookItem::Chapter(ref ch) => Some(ch.name.clone()),
+                _ => None,
+            })
+            .collect();
+        let should_be: Vec<_> = vec![
+            String::from("Chapter 1"),
+            String::from("Hello World"),
+            String::from("Goodbye World"),
+        ];
+
+        assert_eq!(chapter_names, should_be);
+    }
+
+    #[test]
+    fn for_each_mut_visits_all_items() {
+        let mut book = Book {
+            sections: vec![
+                BookItem::Chapter(Chapter {
+                    name: String::from("Chapter 1"),
+                    content: String::from(DUMMY_SRC),
+                    number: None,
+                    path: Some(PathBuf::from("Chapter_1/index.md")),
+                    parent_names: Vec::new(),
+                    sub_items: vec![
+                        BookItem::Chapter(Chapter::new(
+                            "Hello World",
+                            String::new(),
+                            "Chapter_1/hello.md",
+                            Vec::new(),
+                        )),
+                        BookItem::Separator,
+                        BookItem::Chapter(Chapter::new(
+                            "Goodbye World",
+                            String::new(),
+                            "Chapter_1/goodbye.md",
+                            Vec::new(),
+                        )),
+                    ],
+                }),
+                BookItem::Separator,
+            ],
+            ..Default::default()
+        };
+
+        let num_items = book.iter().count();
+        let mut visited = 0;
+
+        book.for_each_mut(|_| visited += 1);
+
+        assert_eq!(visited, num_items);
+    }
+
+    #[test]
+    fn cant_load_chapters_with_an_empty_path() {
+        let (_, temp) = dummy_link();
+        let summary = Summary {
+            numbered_chapters: vec![SummaryItem::Link(Link {
+                name: String::from("Empty"),
+                location: Some(PathBuf::from("")),
+                ..Default::default()
+            })],
+
+            ..Default::default()
+        };
+
+        let got = load_book_from_disk(&summary, temp.path());
+        assert!(got.is_err());
+    }
+
+    #[test]
+    fn cant_load_chapters_when_the_link_is_a_directory() {
+        let (_, temp) = dummy_link();
+        let dir = temp.path().join("nested");
+        fs::create_dir(&dir).unwrap();
+
+        let summary = Summary {
+            numbered_chapters: vec![SummaryItem::Link(Link {
+                name: String::from("nested"),
+                location: Some(dir),
+                ..Default::default()
+            })],
+            ..Default::default()
+        };
+
+        let got = load_book_from_disk(&summary, temp.path());
+        assert!(got.is_err());
+    }
+}

src/book/bookconfig.rs

@@ -1,225 +0,0 @@
-extern crate toml;
-
-use std::process::exit;
-use std::fs::File;
-use std::io::Read;
-use std::path::{Path, PathBuf};
-use std::collections::BTreeMap;
-use std::str::FromStr;
-use serde_json;
-
-#[derive(Debug, Clone)]
-pub struct BookConfig {
-    root: PathBuf,
-    pub dest: PathBuf,
-    pub src: PathBuf,
-    pub theme_path: PathBuf,
-
-    pub title: String,
-    pub author: String,
-    pub description: String,
-
-    pub indent_spaces: i32,
-    multilingual: bool,
-}
-
-impl BookConfig {
-    pub fn new(root: &Path) -> Self {
-        BookConfig {
-            root: root.to_owned(),
-            dest: root.join("book"),
-            src: root.join("src"),
-            theme_path: root.join("theme"),
-
-            title: String::new(),
-            author: String::new(),
-            description: String::new(),
-
-            indent_spaces: 4, // indentation used for SUMMARY.md
-            multilingual: false,
-        }
-    }
-
-    pub fn read_config(&mut self, root: &Path) -> &mut Self {
-
-        debug!("[fn]: read_config");
-
-        let read_file = |path: PathBuf| -> String {
-            let mut data = String::new();
-            let mut f: File = match File::open(&path) {
-                Ok(x) => x,
-                Err(_) => {
-                    error!("[*]: Failed to open {:?}", &path);
-                    exit(2);
-                }
-            };
-            if f.read_to_string(&mut data).is_err() {
-                error!("[*]: Failed to read {:?}", &path);
-                exit(2);
-            }
-            data
-        };
-
-        // Read book.toml or book.json if exists
-
-        if root.join("book.toml").exists() {
-
-            debug!("[*]: Reading config");
-            let data = read_file(root.join("book.toml"));
-            self.parse_from_toml_string(&data);
-
-        } else if root.join("book.json").exists() {
-
-            debug!("[*]: Reading config");
-            let data = read_file(root.join("book.json"));
-            self.parse_from_json_string(&data);
-
-        } else {
-            debug!("[*]: No book.toml or book.json was found, using defaults.");
-        }
-
-        self
-    }
-
-    pub fn parse_from_toml_string(&mut self, data: &str) -> &mut Self {
-        let config = match toml::from_str(data) {
-            Ok(x) => {x},
-            Err(e) => {
-                error!("[*]: Toml parse errors in book.toml: {:?}", e);
-                exit(2);
-            }
-        };
-
-        self.parse_from_btreemap(&config);
-
-        self
-    }
-
-    /// Parses the string to JSON and converts it to BTreeMap<String, toml::Value>.
-    pub fn parse_from_json_string(&mut self, data: &str) -> &mut Self {
-
-        let c: serde_json::Value = match serde_json::from_str(data) {
-            Ok(x) => x,
-            Err(e) => {
-                error!("[*]: JSON parse errors in book.json: {:?}", e);
-                exit(2);
-            }
-        };
-
-        let config = json_object_to_btreemap(c.as_object().unwrap());
-        self.parse_from_btreemap(&config);
-
-        self
-    }
-
-    pub fn parse_from_btreemap(&mut self, config: &BTreeMap<String, toml::Value>) -> &mut Self {
-
-        // Title, author, description
-        if let Some(a) = config.get("title") {
-            self.title = a.to_string().replace("\"", "");
-        }
-        if let Some(a) = config.get("author") {
-            self.author = a.to_string().replace("\"", "");
-        }
-        if let Some(a) = config.get("description") {
-            self.description = a.to_string().replace("\"", "");
-        }
-
-        // Destination folder
-        if let Some(a) = config.get("dest") {
-            let mut dest = PathBuf::from(&a.to_string().replace("\"", ""));
-
-            // If path is relative make it absolute from the parent directory of src
-            if dest.is_relative() {
-                dest = self.get_root().join(&dest);
-            }
-            self.set_dest(&dest);
-        }
-
-        // Source folder
-        if let Some(a) = config.get("src") {
-            let mut src = PathBuf::from(&a.to_string().replace("\"", ""));
-            if src.is_relative() {
-                src = self.get_root().join(&src);
-            }
-            self.set_src(&src);
-        }
-
-        // Theme path folder
-        if let Some(a) = config.get("theme_path") {
-            let mut theme_path = PathBuf::from(&a.to_string().replace("\"", ""));
-            if theme_path.is_relative() {
-                theme_path = self.get_root().join(&theme_path);
-            }
-            self.set_theme_path(&theme_path);
-        }
-
-        self
-    }
-
-    pub fn get_root(&self) -> &Path {
-        &self.root
-    }
-
-    pub fn set_root(&mut self, root: &Path) -> &mut Self {
-        self.root = root.to_owned();
-        self
-    }
-
-    pub fn get_dest(&self) -> &Path {
-        &self.dest
-    }
-
-    pub fn set_dest(&mut self, dest: &Path) -> &mut Self {
-        self.dest = dest.to_owned();
-        self
-    }
-
-    pub fn get_src(&self) -> &Path {
-        &self.src
-    }
-
-    pub fn set_src(&mut self, src: &Path) -> &mut Self {
-        self.src = src.to_owned();
-        self
-    }
-
-    pub fn get_theme_path(&self) -> &Path {
-        &self.theme_path
-    }
-
-    pub fn set_theme_path(&mut self, theme_path: &Path) -> &mut Self {
-        self.theme_path = theme_path.to_owned();
-        self
-    }
-}
-
-pub fn json_object_to_btreemap(json: &serde_json::Map<String, serde_json::Value>) -> BTreeMap<String, toml::Value> {
-    let mut config: BTreeMap<String, toml::Value> = BTreeMap::new();
-
-    for (key, value) in json.iter() {
-        config.insert(
-            String::from_str(key).unwrap(),
-            json_value_to_toml_value(value.to_owned())
-        );
-    }
-
-    config
-}
-
-pub fn json_value_to_toml_value(json: serde_json::Value) -> toml::Value {
-    match json {
-        serde_json::Value::Null => toml::Value::String("".to_string()),
-        serde_json::Value::Bool(x) => toml::Value::Boolean(x),
-        serde_json::Value::Number(ref x) if x.is_i64() => toml::Value::Integer(x.as_i64().unwrap()),
-        serde_json::Value::Number(ref x) if x.is_u64() => toml::Value::Integer(x.as_i64().unwrap()),
-        serde_json::Value::Number(x) => toml::Value::Float(x.as_f64().unwrap()),
-        serde_json::Value::String(x) => toml::Value::String(x),
-        serde_json::Value::Array(x) => {
-            toml::Value::Array(x.iter().map(|v| json_value_to_toml_value(v.to_owned())).collect())
-        },
-        serde_json::Value::Object(x) => {
-            toml::Value::Table(json_object_to_btreemap(&x))
-        },
-    }
-}

src/book/bookconfig_test.rs

@@ -1,349 +0,0 @@
-#![cfg(test)]
-
-use std::path::Path;
-use serde_json;
-use book::bookconfig::*;
-
-#[test]
-fn it_parses_json_config() {
-    let text = r#"
-{
-    "title": "mdBook Documentation",
-    "description": "Create book from markdown files. Like Gitbook but implemented in Rust",
-    "author": "Mathieu David"
-}"#;
-
-    // TODO don't require path argument, take pwd
-    let mut config = BookConfig::new(Path::new("."));
-
-    config.parse_from_json_string(&text.to_string());
-
-    let mut expected = BookConfig::new(Path::new("."));
-    expected.title = "mdBook Documentation".to_string();
-    expected.author = "Mathieu David".to_string();
-    expected.description = "Create book from markdown files. Like Gitbook but implemented in Rust".to_string();
-
-    assert_eq!(format!("{:#?}", config), format!("{:#?}", expected));
-}
-
-#[test]
-fn it_parses_toml_config() {
-    let text = r#"
-title = "mdBook Documentation"
-description = "Create book from markdown files. Like Gitbook but implemented in Rust"
-author = "Mathieu David"
-"#;
-
-    // TODO don't require path argument, take pwd
-    let mut config = BookConfig::new(Path::new("."));
-
-    config.parse_from_toml_string(&text.to_string());
-
-    let mut expected = BookConfig::new(Path::new("."));
-    expected.title = "mdBook Documentation".to_string();
-    expected.author = "Mathieu David".to_string();
-    expected.description = "Create book from markdown files. Like Gitbook but implemented in Rust".to_string();
-
-    assert_eq!(format!("{:#?}", config), format!("{:#?}", expected));
-}
-
-#[test]
-fn it_parses_json_nested_array_to_toml() {
-
-    // Example from:
-    // toml-0.2.1/tests/valid/arrays-nested.json
-
-    let text = r#"
-{
-    "nest": {
-        "type": "array",
-        "value": [
-            {"type": "array", "value": [
-                {"type": "string", "value": "a"}
-            ]},
-            {"type": "array", "value": [
-                {"type": "string", "value": "b"}
-            ]}
-        ]
-    }
-}"#;
-
-    let c: serde_json::Value = serde_json::from_str(&text).unwrap();
-
-    let result = json_object_to_btreemap(&c.as_object().unwrap());
-
-    let expected = r#"{
-    "nest": Table(
-        {
-            "type": String(
-                "array"
-            ),
-            "value": Array(
-                [
-                    Table(
-                        {
-                            "type": String(
-                                "array"
-                            ),
-                            "value": Array(
-                                [
-                                    Table(
-                                        {
-                                            "type": String(
-                                                "string"
-                                            ),
-                                            "value": String(
-                                                "a"
-                                            )
-                                        }
-                                    )
-                                ]
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "array"
-                            ),
-                            "value": Array(
-                                [
-                                    Table(
-                                        {
-                                            "type": String(
-                                                "string"
-                                            ),
-                                            "value": String(
-                                                "b"
-                                            )
-                                        }
-                                    )
-                                ]
-                            )
-                        }
-                    )
-                ]
-            )
-        }
-    )
-}"#;
-
-    assert_eq!(format!("{:#?}", result), expected);
-}
-
-
-#[test]
-fn it_parses_json_arrays_to_toml() {
-
-    // Example from:
-    // toml-0.2.1/tests/valid/arrays.json
-
-    let text = r#"
-{
-    "ints": {
-        "type": "array",
-        "value": [
-            {"type": "integer", "value": "1"},
-            {"type": "integer", "value": "2"},
-            {"type": "integer", "value": "3"}
-        ]
-    },
-    "floats": {
-        "type": "array",
-        "value": [
-            {"type": "float", "value": "1.1"},
-            {"type": "float", "value": "2.1"},
-            {"type": "float", "value": "3.1"}
-        ]
-    },
-    "strings": {
-        "type": "array",
-        "value": [
-            {"type": "string", "value": "a"},
-            {"type": "string", "value": "b"},
-            {"type": "string", "value": "c"}
-        ]
-    },
-    "dates": {
-        "type": "array",
-        "value": [
-            {"type": "datetime", "value": "1987-07-05T17:45:00Z"},
-            {"type": "datetime", "value": "1979-05-27T07:32:00Z"},
-            {"type": "datetime", "value": "2006-06-01T11:00:00Z"}
-        ]
-    }
-}"#;
-
-    let c: serde_json::Value = serde_json::from_str(&text).unwrap();
-
-    let result = json_object_to_btreemap(&c.as_object().unwrap());
-
-    let expected = r#"{
-    "dates": Table(
-        {
-            "type": String(
-                "array"
-            ),
-            "value": Array(
-                [
-                    Table(
-                        {
-                            "type": String(
-                                "datetime"
-                            ),
-                            "value": String(
-                                "1987-07-05T17:45:00Z"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "datetime"
-                            ),
-                            "value": String(
-                                "1979-05-27T07:32:00Z"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "datetime"
-                            ),
-                            "value": String(
-                                "2006-06-01T11:00:00Z"
-                            )
-                        }
-                    )
-                ]
-            )
-        }
-    ),
-    "floats": Table(
-        {
-            "type": String(
-                "array"
-            ),
-            "value": Array(
-                [
-                    Table(
-                        {
-                            "type": String(
-                                "float"
-                            ),
-                            "value": String(
-                                "1.1"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "float"
-                            ),
-                            "value": String(
-                                "2.1"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "float"
-                            ),
-                            "value": String(
-                                "3.1"
-                            )
-                        }
-                    )
-                ]
-            )
-        }
-    ),
-    "ints": Table(
-        {
-            "type": String(
-                "array"
-            ),
-            "value": Array(
-                [
-                    Table(
-                        {
-                            "type": String(
-                                "integer"
-                            ),
-                            "value": String(
-                                "1"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "integer"
-                            ),
-                            "value": String(
-                                "2"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "integer"
-                            ),
-                            "value": String(
-                                "3"
-                            )
-                        }
-                    )
-                ]
-            )
-        }
-    ),
-    "strings": Table(
-        {
-            "type": String(
-                "array"
-            ),
-            "value": Array(
-                [
-                    Table(
-                        {
-                            "type": String(
-                                "string"
-                            ),
-                            "value": String(
-                                "a"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "string"
-                            ),
-                            "value": String(
-                                "b"
-                            )
-                        }
-                    ),
-                    Table(
-                        {
-                            "type": String(
-                                "string"
-                            ),
-                            "value": String(
-                                "c"
-                            )
-                        }
-                    )
-                ]
-            )
-        }
-    )
-}"#;
-
-    assert_eq!(format!("{:#?}", result), expected);
-}

src/book/bookitem.rs

@@ -1,83 +0,0 @@
-use serde::{Serialize, Serializer};
-use serde::ser::SerializeStruct;
-use std::path::PathBuf;
-
-#[derive(Debug, Clone)]
-pub enum BookItem {
-    Chapter(String, Chapter), // String = section
-    Affix(Chapter),
-    Spacer,
-}
-
-#[derive(Debug, Clone)]
-pub struct Chapter {
-    pub name: String,
-    pub path: PathBuf,
-    pub sub_items: Vec<BookItem>,
-}
-
-#[derive(Debug, Clone)]
-pub struct BookItems<'a> {
-    pub items: &'a [BookItem],
-    pub current_index: usize,
-    pub stack: Vec<(&'a [BookItem], usize)>,
-}
-
-
-impl Chapter {
-    pub fn new(name: String, path: PathBuf) -> Self {
-
-        Chapter {
-            name: name,
-            path: path,
-            sub_items: vec![],
-        }
-    }
-}
-
-
-impl Serialize for Chapter {
-    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
-        let mut struct_ = try!(serializer.serialize_struct("Chapter", 2));
-        try!(struct_.serialize_field("name", &self.name));
-        try!(struct_.serialize_field("path", &self.path));
-        struct_.end()
-    }
-}
-
-
-
-// Shamelessly copied from Rustbook
-// (https://github.com/rust-lang/rust/blob/master/src/rustbook/book.rs)
-impl<'a> Iterator for BookItems<'a> {
-    type Item = &'a BookItem;
-
-    fn next(&mut self) -> Option<&'a BookItem> {
-        loop {
-            if self.current_index >= self.items.len() {
-                match self.stack.pop() {
-                    None => return None,
-                    Some((parent_items, parent_idx)) => {
-                        self.items = parent_items;
-                        self.current_index = parent_idx + 1;
-                    },
-                }
-            } else {
-                let cur = &self.items[self.current_index];
-
-                match *cur {
-                    BookItem::Chapter(_, ref ch) | BookItem::Affix(ref ch) => {
-                        self.stack.push((self.items, self.current_index));
-                        self.items = &ch.sub_items[..];
-                        self.current_index = 0;
-                    },
-                    BookItem::Spacer => {
-                        self.current_index += 1;
-                    },
-                }
-
-                return Some(cur);
-            }
-        }
-    }
-}

src/book/init.rs

@@ -0,0 +1,208 @@
+use std::fs::{self, File};
+use std::io::Write;
+use std::path::PathBuf;
+
+use super::MDBook;
+use crate::config::Config;
+use crate::errors::*;
+use crate::theme;
+
+/// A helper for setting up a new book and its directory structure.
+#[derive(Debug, Clone, PartialEq)]
+pub struct BookBuilder {
+    root: PathBuf,
+    create_gitignore: bool,
+    config: Config,
+    copy_theme: bool,
+}
+
+impl BookBuilder {
+    /// Create a new `BookBuilder` which will generate a book in the provided
+    /// root directory.
+    pub fn new<P: Into<PathBuf>>(root: P) -> BookBuilder {
+        BookBuilder {
+            root: root.into(),
+            create_gitignore: false,
+            config: Config::default(),
+            copy_theme: false,
+        }
+    }
+
+    /// Set the `Config` to be used.
+    pub fn with_config(&mut self, cfg: Config) -> &mut BookBuilder {
+        self.config = cfg;
+        self
+    }
+
+    /// Get the config used by the `BookBuilder`.
+    pub fn config(&self) -> &Config {
+        &self.config
+    }
+
+    /// Should the theme be copied into the generated book (so users can tweak
+    /// it)?
+    pub fn copy_theme(&mut self, copy: bool) -> &mut BookBuilder {
+        self.copy_theme = copy;
+        self
+    }
+
+    /// Should we create a `.gitignore` file?
+    pub fn create_gitignore(&mut self, create: bool) -> &mut BookBuilder {
+        self.create_gitignore = create;
+        self
+    }
+
+    /// Generate the actual book. This will:
+    ///
+    /// - Create the directory structure.
+    /// - Stub out some dummy chapters and the `SUMMARY.md`.
+    /// - Create a `.gitignore` (if applicable)
+    /// - Create a themes directory and populate it (if applicable)
+    /// - Generate a `book.toml` file,
+    /// - Then load the book so we can build it or run tests.
+    pub fn build(&self) -> Result<MDBook> {
+        info!("Creating a new book with stub content");
+
+        self.create_directory_structure()
+            .with_context(|| "Unable to create directory structure")?;
+
+        self.create_stub_files()
+            .with_context(|| "Unable to create stub files")?;
+
+        if self.create_gitignore {
+            self.build_gitignore()
+                .with_context(|| "Unable to create .gitignore")?;
+        }
+
+        if self.copy_theme {
+            self.copy_across_theme()
+                .with_context(|| "Unable to copy across the theme")?;
+        }
+
+        self.write_book_toml()?;
+
+        match MDBook::load(&self.root) {
+            Ok(book) => Ok(book),
+            Err(e) => {
+                error!("{}", e);
+
+                panic!(
+                    "The BookBuilder should always create a valid book. If you are seeing this it \
+                     is a bug and should be reported."
+                );
+            }
+        }
+    }
+
+    fn write_book_toml(&self) -> Result<()> {
+        debug!("Writing book.toml");
+        let book_toml = self.root.join("book.toml");
+        let cfg = toml::to_vec(&self.config).with_context(|| "Unable to serialize the config")?;
+
+        File::create(book_toml)
+            .with_context(|| "Couldn't create book.toml")?
+            .write_all(&cfg)
+            .with_context(|| "Unable to write config to book.toml")?;
+        Ok(())
+    }
+
+    fn copy_across_theme(&self) -> Result<()> {
+        debug!("Copying theme");
+
+        let html_config = self.config.html_config().unwrap_or_default();
+        let themedir = html_config
+            .theme
+            .unwrap_or_else(|| self.config.book.src.join("theme"));
+        let themedir = self.root.join(themedir);
+
+        if !themedir.exists() {
+            debug!(
+                "{} does not exist, creating the directory",
+                themedir.display()
+            );
+            fs::create_dir(&themedir)?;
+        }
+
+        let mut index = File::create(themedir.join("index.hbs"))?;
+        index.write_all(theme::INDEX)?;
+
+        let cssdir = themedir.join("css");
+        fs::create_dir(&cssdir)?;
+
+        let mut general_css = File::create(cssdir.join("general.css"))?;
+        general_css.write_all(theme::GENERAL_CSS)?;
+
+        let mut chrome_css = File::create(cssdir.join("chrome.css"))?;
+        chrome_css.write_all(theme::CHROME_CSS)?;
+
+        if html_config.print.enable {
+            let mut print_css = File::create(cssdir.join("print.css"))?;
+            print_css.write_all(theme::PRINT_CSS)?;
+        }
+
+        let mut variables_css = File::create(cssdir.join("variables.css"))?;
+        variables_css.write_all(theme::VARIABLES_CSS)?;
+
+        let mut favicon = File::create(themedir.join("favicon.png"))?;
+        favicon.write_all(theme::FAVICON_PNG)?;
+
+        let mut favicon = File::create(themedir.join("favicon.svg"))?;
+        favicon.write_all(theme::FAVICON_SVG)?;
+
+        let mut js = File::create(themedir.join("book.js"))?;
+        js.write_all(theme::JS)?;
+
+        let mut highlight_css = File::create(themedir.join("highlight.css"))?;
+        highlight_css.write_all(theme::HIGHLIGHT_CSS)?;
+
+        let mut highlight_js = File::create(themedir.join("highlight.js"))?;
+        highlight_js.write_all(theme::HIGHLIGHT_JS)?;
+
+        Ok(())
+    }
+
+    fn build_gitignore(&self) -> Result<()> {
+        debug!("Creating .gitignore");
+
+        let mut f = File::create(self.root.join(".gitignore"))?;
+
+        writeln!(f, "{}", self.config.build.build_dir.display())?;
+
+        Ok(())
+    }
+
+    fn create_stub_files(&self) -> Result<()> {
+        debug!("Creating example book contents");
+        let src_dir = self.root.join(&self.config.book.src);
+
+        let summary = src_dir.join("SUMMARY.md");
+        if !summary.exists() {
+            trace!("No summary found creating stub summary and chapter_1.md.");
+            let mut f = File::create(&summary).with_context(|| "Unable to create SUMMARY.md")?;
+            writeln!(f, "# Summary")?;
+            writeln!(f)?;
+            writeln!(f, "- [Chapter 1](./chapter_1.md)")?;
+
+            let chapter_1 = src_dir.join("chapter_1.md");
+            let mut f =
+                File::create(&chapter_1).with_context(|| "Unable to create chapter_1.md")?;
+            writeln!(f, "# Chapter 1")?;
+        } else {
+            trace!("Existing summary found, no need to create stub files.");
+        }
+        Ok(())
+    }
+
+    fn create_directory_structure(&self) -> Result<()> {
+        debug!("Creating directory tree");
+        fs::create_dir_all(&self.root)?;
+
+        let src = self.root.join(&self.config.book.src);
+        fs::create_dir_all(&src)?;
+
+        let build = self.root.join(&self.config.build.build_dir);
+        fs::create_dir_all(&build)?;
+
+        Ok(())
+    }
+}

src/book/summary.rs

@@ -0,0 +1,976 @@
+use crate::errors::*;
+use memchr::{self, Memchr};
+use pulldown_cmark::{self, Event, Tag};
+use std::fmt::{self, Display, Formatter};
+use std::iter::FromIterator;
+use std::ops::{Deref, DerefMut};
+use std::path::{Path, PathBuf};
+
+/// Parse the text from a `SUMMARY.md` file into a sort of "recipe" to be
+/// used when loading a book from disk.
+///
+/// # Summary Format
+///
+/// **Title:** It's common practice to begin with a title, generally
+/// "# Summary". It's not mandatory and the parser (currently) ignores it, so
+/// you can too if you feel like it.
+///
+/// **Prefix Chapter:** Before the main numbered chapters you can add a couple
+/// of elements that will not be numbered. This is useful for forewords,
+/// introductions, etc. There are however some constraints. You can not nest
+/// prefix chapters, they should all be on the root level. And you can not add
+/// prefix chapters once you have added numbered chapters.
+///
+/// ```markdown
+/// [Title of prefix element](relative/path/to/markdown.md)
+/// ```
+///
+/// **Part Title:** An optional title for the next collect of numbered chapters. The numbered
+/// chapters can be broken into as many parts as desired.
+///
+/// **Numbered Chapter:** Numbered chapters are the main content of the book,
+/// they
+/// will be numbered and can be nested, resulting in a nice hierarchy (chapters,
+/// sub-chapters, etc.)
+///
+/// ```markdown
+/// # Title of Part
+///
+/// - [Title of the Chapter](relative/path/to/markdown.md)
+/// ```
+///
+/// You can either use - or * to indicate a numbered chapter, the parser doesn't
+/// care but you'll probably want to stay consistent.
+///
+/// **Suffix Chapter:** After the numbered chapters you can add a couple of
+/// non-numbered chapters. They are the same as prefix chapters but come after
+/// the numbered chapters instead of before.
+///
+/// All other elements are unsupported and will be ignored at best or result in
+/// an error.
+pub fn parse_summary(summary: &str) -> Result<Summary> {
+    let parser = SummaryParser::new(summary);
+    parser.parse()
+}
+
+/// The parsed `SUMMARY.md`, specifying how the book should be laid out.
+#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
+pub struct Summary {
+    /// An optional title for the `SUMMARY.md`, currently just ignored.
+    pub title: Option<String>,
+    /// Chapters before the main text (e.g. an introduction).
+    pub prefix_chapters: Vec<SummaryItem>,
+    /// The main numbered chapters of the book, broken into one or more possibly named parts.
+    pub numbered_chapters: Vec<SummaryItem>,
+    /// Items which come after the main document (e.g. a conclusion).
+    pub suffix_chapters: Vec<SummaryItem>,
+}
+
+/// A struct representing an entry in the `SUMMARY.md`, possibly with nested
+/// entries.
+///
+/// This is roughly the equivalent of `[Some section](./path/to/file.md)`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct Link {
+    /// The name of the chapter.
+    pub name: String,
+    /// The location of the chapter's source file, taking the book's `src`
+    /// directory as the root.
+    pub location: Option<PathBuf>,
+    /// The section number, if this chapter is in the numbered section.
+    pub number: Option<SectionNumber>,
+    /// Any nested items this chapter may contain.
+    pub nested_items: Vec<SummaryItem>,
+}
+
+impl Link {
+    /// Create a new link with no nested items.
+    pub fn new<S: Into<String>, P: AsRef<Path>>(name: S, location: P) -> Link {
+        Link {
+            name: name.into(),
+            location: Some(location.as_ref().to_path_buf()),
+            number: None,
+            nested_items: Vec::new(),
+        }
+    }
+}
+
+impl Default for Link {
+    fn default() -> Self {
+        Link {
+            name: String::new(),
+            location: Some(PathBuf::new()),
+            number: None,
+            nested_items: Vec::new(),
+        }
+    }
+}
+
+/// An item in `SUMMARY.md` which could be either a separator or a `Link`.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub enum SummaryItem {
+    /// A link to a chapter.
+    Link(Link),
+    /// A separator (`---`).
+    Separator,
+    /// A part title.
+    PartTitle(String),
+}
+
+impl SummaryItem {
+    fn maybe_link_mut(&mut self) -> Option<&mut Link> {
+        match *self {
+            SummaryItem::Link(ref mut l) => Some(l),
+            _ => None,
+        }
+    }
+}
+
+impl From<Link> for SummaryItem {
+    fn from(other: Link) -> SummaryItem {
+        SummaryItem::Link(other)
+    }
+}
+
+/// A recursive descent (-ish) parser for a `SUMMARY.md`.
+///
+///
+/// # Grammar
+///
+/// The `SUMMARY.md` file has a grammar which looks something like this:
+///
+/// ```text
+/// summary           ::= title prefix_chapters numbered_chapters
+///                         suffix_chapters
+/// title             ::= "# " TEXT
+///                     | EPSILON
+/// prefix_chapters   ::= item*
+/// suffix_chapters   ::= item*
+/// numbered_chapters ::= part+
+/// part              ::= title dotted_item+
+/// dotted_item       ::= INDENT* DOT_POINT item
+/// item              ::= link
+///                     | separator
+/// separator         ::= "---"
+/// link              ::= "[" TEXT "]" "(" TEXT ")"
+/// DOT_POINT         ::= "-"
+///                     | "*"
+/// ```
+///
+/// > **Note:** the `TEXT` terminal is "normal" text, and should (roughly)
+/// > match the following regex: "[^<>\n[]]+".
+struct SummaryParser<'a> {
+    src: &'a str,
+    stream: pulldown_cmark::OffsetIter<'a>,
+    offset: usize,
+
+    /// We can't actually put an event back into the `OffsetIter` stream, so instead we store it
+    /// here until somebody calls `next_event` again.
+    back: Option<Event<'a>>,
+}
+
+/// Reads `Events` from the provided stream until the corresponding
+/// `Event::End` is encountered which matches the `$delimiter` pattern.
+///
+/// This is the equivalent of doing
+/// `$stream.take_while(|e| e != $delimeter).collect()` but it allows you to
+/// use pattern matching and you won't get errors because `take_while()`
+/// moves `$stream` out of self.
+macro_rules! collect_events {
+    ($stream:expr,start $delimiter:pat) => {
+        collect_events!($stream, Event::Start($delimiter))
+    };
+    ($stream:expr,end $delimiter:pat) => {
+        collect_events!($stream, Event::End($delimiter))
+    };
+    ($stream:expr, $delimiter:pat) => {{
+        let mut events = Vec::new();
+
+        loop {
+            let event = $stream.next().map(|(ev, _range)| ev);
+            trace!("Next event: {:?}", event);
+
+            match event {
+                Some($delimiter) => break,
+                Some(other) => events.push(other),
+                None => {
+                    debug!(
+                        "Reached end of stream without finding the closing pattern, {}",
+                        stringify!($delimiter)
+                    );
+                    break;
+                }
+            }
+        }
+
+        events
+    }};
+}
+
+impl<'a> SummaryParser<'a> {
+    fn new(text: &str) -> SummaryParser<'_> {
+        let pulldown_parser = pulldown_cmark::Parser::new(text).into_offset_iter();
+
+        SummaryParser {
+            src: text,
+            stream: pulldown_parser,
+            offset: 0,
+            back: None,
+        }
+    }
+
+    /// Get the current line and column to give the user more useful error
+    /// messages.
+    fn current_location(&self) -> (usize, usize) {
+        let previous_text = self.src[..self.offset].as_bytes();
+        let line = Memchr::new(b'\n', previous_text).count() + 1;
+        let start_of_line = memchr::memrchr(b'\n', previous_text).unwrap_or(0);
+        let col = self.src[start_of_line..self.offset].chars().count();
+
+        (line, col)
+    }
+
+    /// Parse the text the `SummaryParser` was created with.
+    fn parse(mut self) -> Result<Summary> {
+        let title = self.parse_title();
+
+        let prefix_chapters = self
+            .parse_affix(true)
+            .with_context(|| "There was an error parsing the prefix chapters")?;
+        let numbered_chapters = self
+            .parse_parts()
+            .with_context(|| "There was an error parsing the numbered chapters")?;
+        let suffix_chapters = self
+            .parse_affix(false)
+            .with_context(|| "There was an error parsing the suffix chapters")?;
+
+        Ok(Summary {
+            title,
+            prefix_chapters,
+            numbered_chapters,
+            suffix_chapters,
+        })
+    }
+
+    /// Parse the affix chapters.
+    fn parse_affix(&mut self, is_prefix: bool) -> Result<Vec<SummaryItem>> {
+        let mut items = Vec::new();
+        debug!(
+            "Parsing {} items",
+            if is_prefix { "prefix" } else { "suffix" }
+        );
+
+        loop {
+            match self.next_event() {
+                Some(ev @ Event::Start(Tag::List(..)))
+                | Some(ev @ Event::Start(Tag::Heading(1))) => {
+                    if is_prefix {
+                        // we've finished prefix chapters and are at the start
+                        // of the numbered section.
+                        self.back(ev);
+                        break;
+                    } else {
+                        bail!(self.parse_error("Suffix chapters cannot be followed by a list"));
+                    }
+                }
+                Some(Event::Start(Tag::Link(_type, href, _title))) => {
+                    let link = self.parse_link(href.to_string());
+                    items.push(SummaryItem::Link(link));
+                }
+                Some(Event::Rule) => items.push(SummaryItem::Separator),
+                Some(_) => {}
+                None => break,
+            }
+        }
+
+        Ok(items)
+    }
+
+    fn parse_parts(&mut self) -> Result<Vec<SummaryItem>> {
+        let mut parts = vec![];
+
+        // We want the section numbers to be continues through all parts.
+        let mut root_number = SectionNumber::default();
+        let mut root_items = 0;
+
+        loop {
+            // Possibly match a title or the end of the "numbered chapters part".
+            let title = match self.next_event() {
+                Some(ev @ Event::Start(Tag::Paragraph)) => {
+                    // we're starting the suffix chapters
+                    self.back(ev);
+                    break;
+                }
+
+                Some(Event::Start(Tag::Heading(1))) => {
+                    debug!("Found a h1 in the SUMMARY");
+
+                    let tags = collect_events!(self.stream, end Tag::Heading(1));
+                    Some(stringify_events(tags))
+                }
+
+                Some(ev) => {
+                    self.back(ev);
+                    None
+                }
+
+                None => break, // EOF, bail...
+            };
+
+            // Parse the rest of the part.
+            let numbered_chapters = self
+                .parse_numbered(&mut root_items, &mut root_number)
+                .with_context(|| "There was an error parsing the numbered chapters")?;
+
+            if let Some(title) = title {
+                parts.push(SummaryItem::PartTitle(title));
+            }
+            parts.extend(numbered_chapters);
+        }
+
+        Ok(parts)
+    }
+
+    /// Finishes parsing a link once the `Event::Start(Tag::Link(..))` has been opened.
+    fn parse_link(&mut self, href: String) -> Link {
+        let href = href.replace("%20", " ");
+        let link_content = collect_events!(self.stream, end Tag::Link(..));
+        let name = stringify_events(link_content);
+
+        let path = if href.is_empty() {
+            None
+        } else {
+            Some(PathBuf::from(href))
+        };
+
+        Link {
+            name,
+            location: path,
+            number: None,
+            nested_items: Vec::new(),
+        }
+    }
+
+    /// Parse the numbered chapters.
+    fn parse_numbered(
+        &mut self,
+        root_items: &mut u32,
+        root_number: &mut SectionNumber,
+    ) -> Result<Vec<SummaryItem>> {
+        let mut items = Vec::new();
+
+        // For the first iteration, we want to just skip any opening paragraph tags, as that just
+        // marks the start of the list. But after that, another opening paragraph indicates that we
+        // have started a new part or the suffix chapters.
+        let mut first = true;
+
+        loop {
+            match self.next_event() {
+                Some(ev @ Event::Start(Tag::Paragraph)) => {
+                    if !first {
+                        // we're starting the suffix chapters
+                        self.back(ev);
+                        break;
+                    }
+                }
+                // The expectation is that pulldown cmark will terminate a paragraph before a new
+                // heading, so we can always count on this to return without skipping headings.
+                Some(ev @ Event::Start(Tag::Heading(1))) => {
+                    // we're starting a new part
+                    self.back(ev);
+                    break;
+                }
+                Some(ev @ Event::Start(Tag::List(..))) => {
+                    self.back(ev);
+                    let mut bunch_of_items = self.parse_nested_numbered(&root_number)?;
+
+                    // if we've resumed after something like a rule the root sections
+                    // will be numbered from 1. We need to manually go back and update
+                    // them
+                    update_section_numbers(&mut bunch_of_items, 0, *root_items);
+                    *root_items += bunch_of_items.len() as u32;
+                    items.extend(bunch_of_items);
+                }
+                Some(Event::Start(other_tag)) => {
+                    trace!("Skipping contents of {:?}", other_tag);
+
+                    // Skip over the contents of this tag
+                    while let Some(event) = self.next_event() {
+                        if event == Event::End(other_tag.clone()) {
+                            break;
+                        }
+                    }
+                }
+                Some(Event::Rule) => {
+                    items.push(SummaryItem::Separator);
+                }
+
+                // something else... ignore
+                Some(_) => {}
+
+                // EOF, bail...
+                None => {
+                    break;
+                }
+            }
+
+            // From now on, we cannot accept any new paragraph opening tags.
+            first = false;
+        }
+
+        Ok(items)
+    }
+
+    /// Push an event back to the tail of the stream.
+    fn back(&mut self, ev: Event<'a>) {
+        assert!(self.back.is_none());
+        trace!("Back: {:?}", ev);
+        self.back = Some(ev);
+    }
+
+    fn next_event(&mut self) -> Option<Event<'a>> {
+        let next = self.back.take().or_else(|| {
+            self.stream.next().map(|(ev, range)| {
+                self.offset = range.start;
+                ev
+            })
+        });
+
+        trace!("Next event: {:?}", next);
+
+        next
+    }
+
+    fn parse_nested_numbered(&mut self, parent: &SectionNumber) -> Result<Vec<SummaryItem>> {
+        debug!("Parsing numbered chapters at level {}", parent);
+        let mut items = Vec::new();
+
+        loop {
+            match self.next_event() {
+                Some(Event::Start(Tag::Item)) => {
+                    let item = self.parse_nested_item(parent, items.len())?;
+                    items.push(item);
+                }
+                Some(Event::Start(Tag::List(..))) => {
+                    // Skip this tag after comment bacause it is not nested.
+                    if items.is_empty() {
+                        continue;
+                    }
+                    // recurse to parse the nested list
+                    let (_, last_item) = get_last_link(&mut items)?;
+                    let last_item_number = last_item
+                        .number
+                        .as_ref()
+                        .expect("All numbered chapters have numbers");
+
+                    let sub_items = self.parse_nested_numbered(last_item_number)?;
+
+                    last_item.nested_items = sub_items;
+                }
+                Some(Event::End(Tag::List(..))) => break,
+                Some(_) => {}
+                None => break,
+            }
+        }
+
+        Ok(items)
+    }
+
+    fn parse_nested_item(
+        &mut self,
+        parent: &SectionNumber,
+        num_existing_items: usize,
+    ) -> Result<SummaryItem> {
+        loop {
+            match self.next_event() {
+                Some(Event::Start(Tag::Paragraph)) => continue,
+                Some(Event::Start(Tag::Link(_type, href, _title))) => {
+                    let mut link = self.parse_link(href.to_string());
+
+                    let mut number = parent.clone();
+                    number.0.push(num_existing_items as u32 + 1);
+                    trace!(
+                        "Found chapter: {} {} ({})",
+                        number,
+                        link.name,
+                        link.location
+                            .as_ref()
+                            .map(|p| p.to_str().unwrap_or(""))
+                            .unwrap_or("[draft]")
+                    );
+
+                    link.number = Some(number);
+
+                    return Ok(SummaryItem::Link(link));
+                }
+                other => {
+                    warn!("Expected a start of a link, actually got {:?}", other);
+                    bail!(self.parse_error(
+                        "The link items for nested chapters must only contain a hyperlink"
+                    ));
+                }
+            }
+        }
+    }
+
+    fn parse_error<D: Display>(&self, msg: D) -> Error {
+        let (line, col) = self.current_location();
+        anyhow::anyhow!(
+            "failed to parse SUMMARY.md line {}, column {}: {}",
+            line,
+            col,
+            msg
+        )
+    }
+
+    /// Try to parse the title line.
+    fn parse_title(&mut self) -> Option<String> {
+        match self.next_event() {
+            Some(Event::Start(Tag::Heading(1))) => {
+                debug!("Found a h1 in the SUMMARY");
+
+                let tags = collect_events!(self.stream, end Tag::Heading(1));
+                Some(stringify_events(tags))
+            }
+            _ => None,
+        }
+    }
+}
+
+fn update_section_numbers(sections: &mut [SummaryItem], level: usize, by: u32) {
+    for section in sections {
+        if let SummaryItem::Link(ref mut link) = *section {
+            if let Some(ref mut number) = link.number {
+                number.0[level] += by;
+            }
+
+            update_section_numbers(&mut link.nested_items, level, by);
+        }
+    }
+}
+
+/// Gets a pointer to the last `Link` in a list of `SummaryItem`s, and its
+/// index.
+fn get_last_link(links: &mut [SummaryItem]) -> Result<(usize, &mut Link)> {
+    links
+        .iter_mut()
+        .enumerate()
+        .filter_map(|(i, item)| item.maybe_link_mut().map(|l| (i, l)))
+        .rev()
+        .next()
+        .ok_or_else(||
+            anyhow::anyhow!("Unable to get last link because the list of SummaryItems doesn't contain any Links")
+            )
+}
+
+/// Removes the styling from a list of Markdown events and returns just the
+/// plain text.
+fn stringify_events(events: Vec<Event<'_>>) -> String {
+    events
+        .into_iter()
+        .filter_map(|t| match t {
+            Event::Text(text) | Event::Code(text) => Some(text.into_string()),
+            Event::SoftBreak => Some(String::from(" ")),
+            _ => None,
+        })
+        .collect()
+}
+
+/// A section number like "1.2.3", basically just a newtype'd `Vec<u32>` with
+/// a pretty `Display` impl.
+#[derive(Debug, PartialEq, Clone, Default, Serialize, Deserialize)]
+pub struct SectionNumber(pub Vec<u32>);
+
+impl Display for SectionNumber {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        if self.0.is_empty() {
+            write!(f, "0")
+        } else {
+            for item in &self.0 {
+                write!(f, "{}.", item)?;
+            }
+            Ok(())
+        }
+    }
+}
+
+impl Deref for SectionNumber {
+    type Target = Vec<u32>;
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for SectionNumber {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl FromIterator<u32> for SectionNumber {
+    fn from_iter<I: IntoIterator<Item = u32>>(it: I) -> Self {
+        SectionNumber(it.into_iter().collect())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn section_number_has_correct_dotted_representation() {
+        let inputs = vec![
+            (vec![0], "0."),
+            (vec![1, 3], "1.3."),
+            (vec![1, 2, 3], "1.2.3."),
+        ];
+
+        for (input, should_be) in inputs {
+            let section_number = SectionNumber(input).to_string();
+            assert_eq!(section_number, should_be);
+        }
+    }
+
+    #[test]
+    fn parse_initial_title() {
+        let src = "# Summary";
+        let should_be = String::from("Summary");
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser.parse_title().unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_title_with_styling() {
+        let src = "# My **Awesome** Summary";
+        let should_be = String::from("My Awesome Summary");
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser.parse_title().unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn convert_markdown_events_to_a_string() {
+        let src = "Hello *World*, `this` is some text [and a link](./path/to/link)";
+        let should_be = "Hello World, this is some text and a link";
+
+        let events = pulldown_cmark::Parser::new(src).collect();
+        let got = stringify_events(events);
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_some_prefix_items() {
+        let src = "[First](./first.md)\n[Second](./second.md)\n";
+        let mut parser = SummaryParser::new(src);
+
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                ..Default::default()
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                ..Default::default()
+            }),
+        ];
+
+        let got = parser.parse_affix(true).unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_prefix_items_with_a_separator() {
+        let src = "[First](./first.md)\n\n---\n\n[Second](./second.md)\n";
+        let mut parser = SummaryParser::new(src);
+
+        let got = parser.parse_affix(true).unwrap();
+
+        assert_eq!(got.len(), 3);
+        assert_eq!(got[1], SummaryItem::Separator);
+    }
+
+    #[test]
+    fn suffix_items_cannot_be_followed_by_a_list() {
+        let src = "[First](./first.md)\n- [Second](./second.md)\n";
+        let mut parser = SummaryParser::new(src);
+
+        let got = parser.parse_affix(false);
+
+        assert!(got.is_err());
+    }
+
+    #[test]
+    fn parse_a_link() {
+        let src = "[First](./first.md)";
+        let should_be = Link {
+            name: String::from("First"),
+            location: Some(PathBuf::from("./first.md")),
+            ..Default::default()
+        };
+
+        let mut parser = SummaryParser::new(src);
+        let _ = parser.stream.next(); // Discard opening paragraph
+
+        let href = match parser.stream.next() {
+            Some((Event::Start(Tag::Link(_type, href, _title)), _range)) => href.to_string(),
+            other => panic!("Unreachable, {:?}", other),
+        };
+
+        let got = parser.parse_link(href);
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_a_numbered_chapter() {
+        let src = "- [First](./first.md)\n";
+        let link = Link {
+            name: String::from("First"),
+            location: Some(PathBuf::from("./first.md")),
+            number: Some(SectionNumber(vec![1])),
+            ..Default::default()
+        };
+        let should_be = vec![SummaryItem::Link(link)];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_nested_numbered_chapters() {
+        let src = "- [First](./first.md)\n  - [Nested](./nested.md)\n- [Second](./second.md)";
+
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: vec![SummaryItem::Link(Link {
+                    name: String::from("Nested"),
+                    location: Some(PathBuf::from("./nested.md")),
+                    number: Some(SectionNumber(vec![1, 1])),
+                    nested_items: Vec::new(),
+                })],
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_numbered_chapters_separated_by_comment() {
+        let src = "- [First](./first.md)\n<!-- this is a comment -->\n- [Second](./second.md)";
+
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn parse_titled_parts() {
+        let src = "- [First](./first.md)\n- [Second](./second.md)\n\
+                   # Title 2\n- [Third](./third.md)\n\t- [Fourth](./fourth.md)";
+
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::PartTitle(String::from("Title 2")),
+            SummaryItem::Link(Link {
+                name: String::from("Third"),
+                location: Some(PathBuf::from("./third.md")),
+                number: Some(SectionNumber(vec![3])),
+                nested_items: vec![SummaryItem::Link(Link {
+                    name: String::from("Fourth"),
+                    location: Some(PathBuf::from("./fourth.md")),
+                    number: Some(SectionNumber(vec![3, 1])),
+                    nested_items: Vec::new(),
+                })],
+            }),
+        ];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser.parse_parts().unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    /// This test ensures the book will continue to pass because it breaks the
+    /// `SUMMARY.md` up using level 2 headers ([example]).
+    ///
+    /// [example]: https://github.com/rust-lang/book/blob/2c942dc094f4ddcdc7aba7564f80782801197c99/second-edition/src/SUMMARY.md#basic-rust-literacy
+    #[test]
+    fn can_have_a_subheader_between_nested_items() {
+        let src = "- [First](./first.md)\n\n## Subheading\n\n- [Second](./second.md)\n";
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn an_empty_link_location_is_a_draft_chapter() {
+        let src = "- [Empty]()\n";
+        let mut parser = SummaryParser::new(src);
+
+        let got = parser.parse_numbered(&mut 0, &mut SectionNumber::default());
+        let should_be = vec![SummaryItem::Link(Link {
+            name: String::from("Empty"),
+            location: None,
+            number: Some(SectionNumber(vec![1])),
+            nested_items: Vec::new(),
+        })];
+
+        assert!(got.is_ok());
+        assert_eq!(got.unwrap(), should_be);
+    }
+
+    /// Regression test for https://github.com/rust-lang/mdBook/issues/779
+    /// Ensure section numbers are correctly incremented after a horizontal separator.
+    #[test]
+    fn keep_numbering_after_separator() {
+        let src =
+            "- [First](./first.md)\n---\n- [Second](./second.md)\n---\n- [Third](./third.md)\n";
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("First"),
+                location: Some(PathBuf::from("./first.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Separator,
+            SummaryItem::Link(Link {
+                name: String::from("Second"),
+                location: Some(PathBuf::from("./second.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Separator,
+            SummaryItem::Link(Link {
+                name: String::from("Third"),
+                location: Some(PathBuf::from("./third.md")),
+                number: Some(SectionNumber(vec![3])),
+                nested_items: Vec::new(),
+            }),
+        ];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    /// Regression test for https://github.com/rust-lang/mdBook/issues/1218
+    /// Ensure chapter names spread across multiple lines have spaces between all the words.
+    #[test]
+    fn add_space_for_multi_line_chapter_names() {
+        let src = "- [Chapter\ntitle](./chapter.md)";
+        let should_be = vec![SummaryItem::Link(Link {
+            name: String::from("Chapter title"),
+            location: Some(PathBuf::from("./chapter.md")),
+            number: Some(SectionNumber(vec![1])),
+            nested_items: Vec::new(),
+        })];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn allow_space_in_link_destination() {
+        let src = "- [test1](./test%20link1.md)\n- [test2](<./test link2.md>)";
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("test1"),
+                location: Some(PathBuf::from("./test link1.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("test2"),
+                location: Some(PathBuf::from("./test link2.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+}

src/cmd/build.rs

@@ -0,0 +1,39 @@
+use crate::{get_book_dir, open};
+use clap::{App, ArgMatches, SubCommand};
+use mdbook::errors::Result;
+use mdbook::MDBook;
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("build")
+        .about("Builds a book from its markdown files")
+        .arg_from_usage(
+            "-d, --dest-dir=[dest-dir] 'Output directory for the book{n}\
+             Relative paths are interpreted relative to the book's root directory.{n}\
+             If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.'",
+        )
+        .arg_from_usage(
+            "[dir] 'Root directory for the book{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+        .arg_from_usage("-o, --open 'Opens the compiled book in a web browser'")
+}
+
+// Build command implementation
+pub fn execute(args: &ArgMatches) -> Result<()> {
+    let book_dir = get_book_dir(args);
+    let mut book = MDBook::load(&book_dir)?;
+
+    if let Some(dest_dir) = args.value_of("dest-dir") {
+        book.config.build.build_dir = dest_dir.into();
+    }
+
+    book.build()?;
+
+    if args.is_present("open") {
+        // FIXME: What's the right behaviour if we don't use the HTML renderer?
+        open(book.build_dir_for("html").join("index.html"));
+    }
+
+    Ok(())
+}

src/cmd/clean.rs

@@ -0,0 +1,39 @@
+use crate::get_book_dir;
+use anyhow::Context;
+use clap::{App, ArgMatches, SubCommand};
+use mdbook::MDBook;
+use std::fs;
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("clean")
+        .about("Deletes a built book")
+        .arg_from_usage(
+            "-d, --dest-dir=[dest-dir] 'Output directory for the book{n}\
+             Relative paths are interpreted relative to the book's root directory.{n}\
+             Running this command deletes this directory.{n}\
+             If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.'",
+        )
+        .arg_from_usage(
+            "[dir] 'Root directory for the book{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+}
+
+// Clean command implementation
+pub fn execute(args: &ArgMatches) -> mdbook::errors::Result<()> {
+    let book_dir = get_book_dir(args);
+    let book = MDBook::load(&book_dir)?;
+
+    let dir_to_remove = match args.value_of("dest-dir") {
+        Some(dest_dir) => dest_dir.into(),
+        None => book.root.join(&book.config.build.build_dir),
+    };
+
+    if dir_to_remove.exists() {
+        fs::remove_dir_all(&dir_to_remove)
+            .with_context(|| "Unable to remove the build directory")?;
+    }
+
+    Ok(())
+}

src/cmd/init.rs

@@ -0,0 +1,109 @@
+use crate::get_book_dir;
+use clap::{App, ArgMatches, SubCommand};
+use mdbook::config;
+use mdbook::errors::Result;
+use mdbook::MDBook;
+use std::io;
+use std::io::Write;
+use std::process::Command;
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("init")
+        .about("Creates the boilerplate structure and files for a new book")
+        // the {n} denotes a newline which will properly aligned in all help messages
+        .arg_from_usage(
+            "[dir] 'Directory to create the book in{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+        .arg_from_usage("--theme 'Copies the default theme into your source folder'")
+        .arg_from_usage("--force 'Skips confirmation prompts'")
+}
+
+// Init command implementation
+pub fn execute(args: &ArgMatches) -> Result<()> {
+    let book_dir = get_book_dir(args);
+    let mut builder = MDBook::init(&book_dir);
+    let mut config = config::Config::default();
+
+    // If flag `--theme` is present, copy theme to src
+    if args.is_present("theme") {
+        config.set("output.html.theme", "src/theme")?;
+        // Skip this if `--force` is present
+        if !args.is_present("force") {
+            // Print warning
+            println!();
+            println!(
+                "Copying the default theme to {}",
+                builder.config().book.src.display()
+            );
+            println!("This could potentially overwrite files already present in that directory.");
+            print!("\nAre you sure you want to continue? (y/n) ");
+
+            // Read answer from user and exit if it's not 'yes'
+            if confirm() {
+                builder.copy_theme(true);
+            }
+        } else {
+            builder.copy_theme(true);
+        }
+    }
+
+    println!("\nDo you want a .gitignore to be created? (y/n)");
+
+    if confirm() {
+        builder.create_gitignore(true);
+    }
+
+    config.book.title = request_book_title();
+
+    if let Some(author) = get_author_name() {
+        debug!("Obtained user name from gitconfig: {:?}", author);
+        config.book.authors.push(author);
+        builder.with_config(config);
+    }
+
+    builder.build()?;
+    println!("\nAll done, no errors...");
+
+    Ok(())
+}
+
+/// Obtains author name from git config file by running the `git config` command.
+fn get_author_name() -> Option<String> {
+    let output = Command::new("git")
+        .args(&["config", "--get", "user.name"])
+        .output()
+        .ok()?;
+
+    if output.status.success() {
+        Some(String::from_utf8_lossy(&output.stdout).trim().to_owned())
+    } else {
+        None
+    }
+}
+
+/// Request book title from user and return if provided.
+fn request_book_title() -> Option<String> {
+    println!("What title would you like to give the book? ");
+    io::stdout().flush().unwrap();
+    let mut resp = String::new();
+    io::stdin().read_line(&mut resp).unwrap();
+    let resp = resp.trim();
+    if resp.is_empty() {
+        None
+    } else {
+        Some(resp.into())
+    }
+}
+
+// Simple function for user confirmation
+fn confirm() -> bool {
+    io::stdout().flush().unwrap();
+    let mut s = String::new();
+    io::stdin().read_line(&mut s).ok();
+    match &*s.trim() {
+        "Y" | "y" | "yes" | "Yes" => true,
+        _ => false,
+    }
+}

src/cmd/mod.rs

@@ -0,0 +1,10 @@
+//! Subcommand modules for the `mdbook` binary.
+
+pub mod build;
+pub mod clean;
+pub mod init;
+#[cfg(feature = "serve")]
+pub mod serve;
+pub mod test;
+#[cfg(feature = "watch")]
+pub mod watch;

src/cmd/serve.rs

@@ -0,0 +1,165 @@
+#[cfg(feature = "watch")]
+use super::watch;
+use crate::{get_book_dir, open};
+use clap::{App, Arg, ArgMatches, SubCommand};
+use futures_util::sink::SinkExt;
+use futures_util::StreamExt;
+use mdbook::errors::*;
+use mdbook::utils;
+use mdbook::utils::fs::get_404_output_file;
+use mdbook::MDBook;
+use std::net::{SocketAddr, ToSocketAddrs};
+use std::path::PathBuf;
+use tokio::sync::broadcast;
+use warp::ws::Message;
+use warp::Filter;
+
+/// The HTTP endpoint for the websocket used to trigger reloads when a file changes.
+const LIVE_RELOAD_ENDPOINT: &str = "__livereload";
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("serve")
+        .about("Serves a book at http://localhost:3000, and rebuilds it on changes")
+        .arg_from_usage(
+            "-d, --dest-dir=[dest-dir] 'Output directory for the book{n}\
+             Relative paths are interpreted relative to the book's root directory.{n}\
+             If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.'",
+        )
+        .arg_from_usage(
+            "[dir] 'Root directory for the book{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+        .arg(
+            Arg::with_name("hostname")
+                .short("n")
+                .long("hostname")
+                .takes_value(true)
+                .default_value("localhost")
+                .empty_values(false)
+                .help("Hostname to listen on for HTTP connections"),
+        )
+        .arg(
+            Arg::with_name("port")
+                .short("p")
+                .long("port")
+                .takes_value(true)
+                .default_value("3000")
+                .empty_values(false)
+                .help("Port to use for HTTP connections"),
+        )
+        .arg_from_usage("-o, --open 'Opens the book server in a web browser'")
+}
+
+// Serve command implementation
+pub fn execute(args: &ArgMatches) -> Result<()> {
+    let book_dir = get_book_dir(args);
+    let mut book = MDBook::load(&book_dir)?;
+
+    let port = args.value_of("port").unwrap();
+    let hostname = args.value_of("hostname").unwrap();
+    let open_browser = args.is_present("open");
+
+    let address = format!("{}:{}", hostname, port);
+
+    let livereload_url = format!("ws://{}/{}", address, LIVE_RELOAD_ENDPOINT);
+    let update_config = |book: &mut MDBook| {
+        book.config
+            .set("output.html.livereload-url", &livereload_url)
+            .expect("livereload-url update failed");
+        if let Some(dest_dir) = args.value_of("dest-dir") {
+            book.config.build.build_dir = dest_dir.into();
+        }
+        // Override site-url for local serving of the 404 file
+        book.config.set("output.html.site-url", "/").unwrap();
+    };
+    update_config(&mut book);
+    book.build()?;
+
+    let sockaddr: SocketAddr = address
+        .to_socket_addrs()?
+        .next()
+        .ok_or_else(|| anyhow::anyhow!("no address found for {}", address))?;
+    let build_dir = book.build_dir_for("html");
+    let input_404 = book
+        .config
+        .get("output.html.input-404")
+        .map(toml::Value::as_str)
+        .and_then(std::convert::identity) // flatten
+        .map(ToString::to_string);
+    let file_404 = get_404_output_file(&input_404);
+
+    // A channel used to broadcast to any websockets to reload when a file changes.
+    let (tx, _rx) = tokio::sync::broadcast::channel::<Message>(100);
+
+    let reload_tx = tx.clone();
+    let thread_handle = std::thread::spawn(move || {
+        serve(build_dir, sockaddr, reload_tx, &file_404);
+    });
+
+    let serving_url = format!("http://{}", address);
+    info!("Serving on: {}", serving_url);
+
+    if open_browser {
+        open(serving_url);
+    }
+
+    #[cfg(feature = "watch")]
+    watch::trigger_on_change(&book, move |paths, book_dir| {
+        info!("Files changed: {:?}", paths);
+        info!("Building book...");
+
+        // FIXME: This area is really ugly because we need to re-set livereload :(
+        let result = MDBook::load(&book_dir).and_then(|mut b| {
+            update_config(&mut b);
+            b.build()
+        });
+
+        if let Err(e) = result {
+            error!("Unable to load the book");
+            utils::log_backtrace(&e);
+        } else {
+            let _ = tx.send(Message::text("reload"));
+        }
+    });
+
+    let _ = thread_handle.join();
+
+    Ok(())
+}
+
+#[tokio::main]
+async fn serve(
+    build_dir: PathBuf,
+    address: SocketAddr,
+    reload_tx: broadcast::Sender<Message>,
+    file_404: &str,
+) {
+    // A warp Filter which captures `reload_tx` and provides an `rx` copy to
+    // receive reload messages.
+    let sender = warp::any().map(move || reload_tx.subscribe());
+
+    // A warp Filter to handle the livereload endpoint. This upgrades to a
+    // websocket, and then waits for any filesystem change notifications, and
+    // relays them over the websocket.
+    let livereload = warp::path(LIVE_RELOAD_ENDPOINT)
+        .and(warp::ws())
+        .and(sender)
+        .map(|ws: warp::ws::Ws, mut rx: broadcast::Receiver<Message>| {
+            ws.on_upgrade(move |ws| async move {
+                let (mut user_ws_tx, _user_ws_rx) = ws.split();
+                trace!("websocket got connection");
+                if let Ok(m) = rx.recv().await {
+                    trace!("notify of reload");
+                    let _ = user_ws_tx.send(m).await;
+                }
+            })
+        });
+    // A warp Filter that serves from the filesystem.
+    let book_route = warp::fs::dir(build_dir.clone());
+    // The fallback route for 404 errors
+    let fallback_route = warp::fs::file(build_dir.join(file_404))
+        .map(|reply| warp::reply::with_status(reply, warp::http::StatusCode::NOT_FOUND));
+    let routes = livereload.or(book_route).or(fallback_route);
+    warp::serve(routes).run(address).await;
+}

src/cmd/test.rs

@@ -0,0 +1,46 @@
+use crate::get_book_dir;
+use clap::{App, Arg, ArgMatches, SubCommand};
+use mdbook::errors::Result;
+use mdbook::MDBook;
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("test")
+        .about("Tests that a book's Rust code samples compile")
+        .arg_from_usage(
+            "-d, --dest-dir=[dest-dir] 'Output directory for the book{n}\
+             Relative paths are interpreted relative to the book's root directory.{n}\
+             If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.'",
+        )
+        .arg_from_usage(
+            "[dir] 'Root directory for the book{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+        .arg(Arg::with_name("library-path")
+            .short("L")
+            .long("library-path")
+            .value_name("dir")
+            .takes_value(true)
+            .require_delimiter(true)
+            .multiple(true)
+            .empty_values(false)
+            .help("A comma-separated list of directories to add to {n}the crate search path when building tests"))
+}
+
+// test command implementation
+pub fn execute(args: &ArgMatches) -> Result<()> {
+    let library_paths: Vec<&str> = args
+        .values_of("library-path")
+        .map(std::iter::Iterator::collect)
+        .unwrap_or_default();
+    let book_dir = get_book_dir(args);
+    let mut book = MDBook::load(&book_dir)?;
+
+    if let Some(dest_dir) = args.value_of("dest-dir") {
+        book.config.build.build_dir = dest_dir.into();
+    }
+
+    book.test(library_paths)?;
+
+    Ok(())
+}

src/cmd/watch.rs

@@ -0,0 +1,164 @@
+use crate::{get_book_dir, open};
+use clap::{App, ArgMatches, SubCommand};
+use mdbook::errors::Result;
+use mdbook::utils;
+use mdbook::MDBook;
+use notify::Watcher;
+use std::path::{Path, PathBuf};
+use std::sync::mpsc::channel;
+use std::thread::sleep;
+use std::time::Duration;
+
+// Create clap subcommand arguments
+pub fn make_subcommand<'a, 'b>() -> App<'a, 'b> {
+    SubCommand::with_name("watch")
+        .about("Watches a book's files and rebuilds it on changes")
+        .arg_from_usage(
+            "-d, --dest-dir=[dest-dir] 'Output directory for the book{n}\
+             Relative paths are interpreted relative to the book's root directory.{n}\
+             If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.'",
+        )
+        .arg_from_usage(
+            "[dir] 'Root directory for the book{n}\
+             (Defaults to the Current Directory when omitted)'",
+        )
+        .arg_from_usage("-o, --open 'Open the compiled book in a web browser'")
+}
+
+// Watch command implementation
+pub fn execute(args: &ArgMatches) -> Result<()> {
+    let book_dir = get_book_dir(args);
+    let mut book = MDBook::load(&book_dir)?;
+
+    let update_config = |book: &mut MDBook| {
+        if let Some(dest_dir) = args.value_of("dest-dir") {
+            book.config.build.build_dir = dest_dir.into();
+        }
+    };
+    update_config(&mut book);
+
+    if args.is_present("open") {
+        book.build()?;
+        open(book.build_dir_for("html").join("index.html"));
+    }
+
+    trigger_on_change(&book, |paths, book_dir| {
+        info!("Files changed: {:?}\nBuilding book...\n", paths);
+        let result = MDBook::load(&book_dir).and_then(|mut b| {
+            update_config(&mut b);
+            b.build()
+        });
+
+        if let Err(e) = result {
+            error!("Unable to build the book");
+            utils::log_backtrace(&e);
+        }
+    });
+
+    Ok(())
+}
+
+fn remove_ignored_files(book_root: &PathBuf, paths: &[PathBuf]) -> Vec<PathBuf> {
+    if paths.is_empty() {
+        return vec![];
+    }
+
+    match find_gitignore(book_root) {
+        Some(gitignore_path) => {
+            match gitignore::File::new(gitignore_path.as_path()) {
+                Ok(exclusion_checker) => filter_ignored_files(exclusion_checker, paths),
+                Err(_) => {
+                    // We're unable to read the .gitignore file, so we'll silently allow everything.
+                    // Please see discussion: https://github.com/rust-lang/mdBook/pull/1051
+                    paths.iter().map(|path| path.to_path_buf()).collect()
+                }
+            }
+        }
+        None => {
+            // There is no .gitignore file.
+            paths.iter().map(|path| path.to_path_buf()).collect()
+        }
+    }
+}
+
+fn find_gitignore(book_root: &PathBuf) -> Option<PathBuf> {
+    book_root
+        .ancestors()
+        .map(|p| p.join(".gitignore"))
+        .find(|p| p.exists())
+}
+
+fn filter_ignored_files(exclusion_checker: gitignore::File, paths: &[PathBuf]) -> Vec<PathBuf> {
+    paths
+        .iter()
+        .filter(|path| match exclusion_checker.is_excluded(path) {
+            Ok(exclude) => !exclude,
+            Err(error) => {
+                warn!(
+                    "Unable to determine if {:?} is excluded: {:?}. Including it.",
+                    &path, error
+                );
+                true
+            }
+        })
+        .map(|path| path.to_path_buf())
+        .collect()
+}
+
+/// Calls the closure when a book source file is changed, blocking indefinitely.
+pub fn trigger_on_change<F>(book: &MDBook, closure: F)
+where
+    F: Fn(Vec<PathBuf>, &Path),
+{
+    use notify::DebouncedEvent::*;
+    use notify::RecursiveMode::*;
+
+    // Create a channel to receive the events.
+    let (tx, rx) = channel();
+
+    let mut watcher = match notify::watcher(tx, Duration::from_secs(1)) {
+        Ok(w) => w,
+        Err(e) => {
+            error!("Error while trying to watch the files:\n\n\t{:?}", e);
+            std::process::exit(1)
+        }
+    };
+
+    // Add the source directory to the watcher
+    if let Err(e) = watcher.watch(book.source_dir(), Recursive) {
+        error!("Error while watching {:?}:\n    {:?}", book.source_dir(), e);
+        std::process::exit(1);
+    };
+
+    let _ = watcher.watch(book.theme_dir(), Recursive);
+
+    // Add the book.toml file to the watcher if it exists
+    let _ = watcher.watch(book.root.join("book.toml"), NonRecursive);
+
+    info!("Listening for changes...");
+
+    loop {
+        let first_event = rx.recv().unwrap();
+        sleep(Duration::from_millis(50));
+        let other_events = rx.try_iter();
+
+        let all_events = std::iter::once(first_event).chain(other_events);
+
+        let paths = all_events
+            .filter_map(|event| {
+                debug!("Received filesystem event: {:?}", event);
+
+                match event {
+                    Create(path) | Write(path) | Remove(path) | Rename(_, path) => Some(path),
+                    _ => None,
+                }
+            })
+            .collect::<Vec<_>>();
+
+        let paths = remove_ignored_files(&book.root, &paths[..]);
+
+        if !paths.is_empty() {
+            closure(paths, &book.root);
+        }
+    }
+}

src/lib.rs

@@ -1,89 +1,122 @@
 //! # mdBook
 //!
-//! **mdBook** is similar to Gitbook but implemented in Rust.
-//! It offers a command line interface, but can also be used as a regular crate.
+//! **mdBook** is a tool for rendering a collection of markdown documents into
+//! a form more suitable for end users like HTML or EPUB.  It offers a command
+//! line interface, but this crate can be used if more control is required.
 //!
-//! This is the API doc, but you can find a [less "low-level" documentation here](../index.html) that
-//! contains information about the command line tool, format, structure etc.
-//! It is also rendered with mdBook to showcase the features and default theme.
+//! This is the API doc, the [user guide] is also available if you want
+//! information about the command line tool, format, structure etc. It is also
+//! rendered with mdBook to showcase the features and default theme.
 //!
 //! Some reasons why you would want to use the crate (over the cli):
 //!
 //! - Integrate mdbook in a current project
 //! - Extend the capabilities of mdBook
 //! - Do some processing or test before building your book
-//! - Write a new Renderer
+//! - Accessing the public API to help create a new Renderer
 //! - ...
 //!
-//! ## Example
+//! > **Note:** While we try to ensure `mdbook`'s command-line interface and
+//! > behaviour are backwards compatible, the tool's internals are still
+//! > evolving and being iterated on. If you wish to prevent accidental
+//! > breakages it is recommended to pin any tools building on top of the
+//! > `mdbook` crate to a specific release.
 //!
-//! ```no_run
-//! extern crate mdbook;
+//! # Examples
 //!
+//! If creating a new book from scratch, you'll want to get a `BookBuilder` via
+//! the `MDBook::init()` method.
+//!
+//! ```rust,no_run
 //! use mdbook::MDBook;
-//! use std::path::Path;
+//! use mdbook::config::Config;
 //!
-//! fn main() {
-//!     let mut book =  MDBook::new(Path::new("my-book"))   // Path to root
-//!                         .set_src(Path::new("src"))      // Path from root to source directory
-//!                         .set_dest(Path::new("book"))    // Path from root to output directory
-//!                         .read_config();                 // Parse book.json file for configuration
+//! let root_dir = "/path/to/book/root";
 //!
-//!     book.build().unwrap();                              // Render the book
-//! }
+//! // create a default config and change a couple things
+//! let mut cfg = Config::default();
+//! cfg.book.title = Some("My Book".to_string());
+//! cfg.book.authors.push("Michael-F-Bryan".to_string());
+//!
+//! MDBook::init(root_dir)
+//!     .create_gitignore(true)
+//!     .with_config(cfg)
+//!     .build()
+//!     .expect("Book generation failed");
 //! ```
 //!
-//! ## Implementing a new Renderer
+//! You can also load an existing book and build it.
 //!
-//! If you want to create a new renderer for mdBook, the only thing you have to do is to implement
-//! the [Renderer trait](renderer/renderer/trait.Renderer.html)
+//! ```rust,no_run
+//! use mdbook::MDBook;
 //!
-//! And then you can swap in your renderer like this:
+//! let root_dir = "/path/to/book/root";
 //!
-//! ```no_run
-//! # extern crate mdbook;
-//! #
-//! # use mdbook::MDBook;
-//! # use mdbook::renderer::HtmlHandlebars;
-//! # use std::path::Path;
-//! #
-//! # fn main() {
-//! #   let your_renderer = HtmlHandlebars::new();
-//! #
-//!     let book =  MDBook::new(Path::new("my-book")).set_renderer(Box::new(your_renderer));
-//! # }
+//! let mut md = MDBook::load(root_dir)
+//!     .expect("Unable to load the book");
+//! md.build().expect("Building failed");
 //! ```
-//! If you make a renderer, you get the book constructed in form of `Vec<BookItems>` and you get
-//! the book config in a `BookConfig` struct.
 //!
-//! It's your responsability to create the necessary files in the correct directories.
+//! ## Implementing a new Backend
 //!
-//! ## utils
+//! `mdbook` has a fairly flexible mechanism for creating additional backends
+//! for your book. The general idea is you'll add an extra table in the book's
+//! `book.toml` which specifies an executable to be invoked by `mdbook`. This
+//! executable will then be called during a build, with an in-memory
+//! representation ([`RenderContext`]) of the book being passed to the
+//! subprocess via `stdin`.
 //!
-//! I have regrouped some useful functions in the [utils](utils/index.html) module, like the following function
+//! The [`RenderContext`] gives the backend access to the contents of
+//! `book.toml` and lets it know which directory all generated artefacts should
+//! be placed in. For a much more in-depth explanation, consult the [relevant
+//! chapter] in the *For Developers* section of the user guide.
 //!
-//! ```ignore
-//! utils::fs::create_path(path: &Path)
-//! ```
-//! This function creates all the directories in a given path if they do not exist
+//! To make creating a backend easier, the `mdbook` crate can be imported
+//! directly, making deserializing the `RenderContext` easy and giving you
+//! access to the various methods for working with the [`Config`].
 //!
-//! Make sure to take a look at it.
+//! [user guide]: https://rust-lang.github.io/mdBook/
+//! [`RenderContext`]: renderer/struct.RenderContext.html
+//! [relevant chapter]: https://rust-lang.github.io/mdBook/for_developers/backends.html
+//! [`Config`]: config/struct.Config.html
 
-extern crate serde;
+#![deny(missing_docs)]
+#![deny(rust_2018_idioms)]
+#![allow(clippy::comparison_chain)]
+
+#[macro_use]
+extern crate lazy_static;
+#[macro_use]
+extern crate log;
+#[macro_use]
+extern crate serde_derive;
 #[macro_use]
 extern crate serde_json;
-extern crate handlebars;
-extern crate pulldown_cmark;
-extern crate regex;
 
-#[macro_use] extern crate log;
+#[cfg(test)]
+#[macro_use]
+extern crate pretty_assertions;
+
 pub mod book;
-mod parse;
+pub mod config;
+pub mod preprocess;
 pub mod renderer;
 pub mod theme;
 pub mod utils;
 
-pub use book::MDBook;
-pub use book::BookItem;
-pub use book::BookConfig;
-pub use renderer::Renderer;
+/// The current version of `mdbook`.
+///
+/// This is provided as a way for custom preprocessors and renderers to do
+/// compatibility checks.
+pub const MDBOOK_VERSION: &str = env!("CARGO_PKG_VERSION");
+
+pub use crate::book::BookItem;
+pub use crate::book::MDBook;
+pub use crate::config::Config;
+pub use crate::renderer::Renderer;
+
+/// The error types used through out this crate.
+pub mod errors {
+    pub(crate) use anyhow::{bail, ensure, Context};
+    pub use anyhow::{Error, Result};
+}

src/main.rs

@@ -0,0 +1,109 @@
+#[macro_use]
+extern crate clap;
+#[macro_use]
+extern crate log;
+
+use chrono::Local;
+use clap::{App, AppSettings, ArgMatches};
+use env_logger::Builder;
+use log::LevelFilter;
+use mdbook::utils;
+use std::env;
+use std::ffi::OsStr;
+use std::io::Write;
+use std::path::{Path, PathBuf};
+
+mod cmd;
+
+const VERSION: &str = concat!("v", crate_version!());
+
+fn main() {
+    init_logger();
+
+    // Create a list of valid arguments and sub-commands
+    let app = App::new(crate_name!())
+        .about(crate_description!())
+        .author("Mathieu David <mathieudavid@mathieudavid.org>")
+        .version(VERSION)
+        .setting(AppSettings::GlobalVersion)
+        .setting(AppSettings::ArgRequiredElseHelp)
+        .setting(AppSettings::ColoredHelp)
+        .after_help(
+            "For more information about a specific command, try `mdbook <command> --help`\n\
+             The source code for mdBook is available at: https://github.com/rust-lang/mdBook",
+        )
+        .subcommand(cmd::init::make_subcommand())
+        .subcommand(cmd::build::make_subcommand())
+        .subcommand(cmd::test::make_subcommand())
+        .subcommand(cmd::clean::make_subcommand());
+
+    #[cfg(feature = "watch")]
+    let app = app.subcommand(cmd::watch::make_subcommand());
+    #[cfg(feature = "serve")]
+    let app = app.subcommand(cmd::serve::make_subcommand());
+
+    // Check which subcomamnd the user ran...
+    let res = match app.get_matches().subcommand() {
+        ("init", Some(sub_matches)) => cmd::init::execute(sub_matches),
+        ("build", Some(sub_matches)) => cmd::build::execute(sub_matches),
+        ("clean", Some(sub_matches)) => cmd::clean::execute(sub_matches),
+        #[cfg(feature = "watch")]
+        ("watch", Some(sub_matches)) => cmd::watch::execute(sub_matches),
+        #[cfg(feature = "serve")]
+        ("serve", Some(sub_matches)) => cmd::serve::execute(sub_matches),
+        ("test", Some(sub_matches)) => cmd::test::execute(sub_matches),
+        (_, _) => unreachable!(),
+    };
+
+    if let Err(e) = res {
+        utils::log_backtrace(&e);
+
+        std::process::exit(101);
+    }
+}
+
+fn init_logger() {
+    let mut builder = Builder::new();
+
+    builder.format(|formatter, record| {
+        writeln!(
+            formatter,
+            "{} [{}] ({}): {}",
+            Local::now().format("%Y-%m-%d %H:%M:%S"),
+            record.level(),
+            record.target(),
+            record.args()
+        )
+    });
+
+    if let Ok(var) = env::var("RUST_LOG") {
+        builder.parse_filters(&var);
+    } else {
+        // if no RUST_LOG provided, default to logging at the Info level
+        builder.filter(None, LevelFilter::Info);
+        // Filter extraneous html5ever not-implemented messages
+        builder.filter(Some("html5ever"), LevelFilter::Error);
+    }
+
+    builder.init();
+}
+
+fn get_book_dir(args: &ArgMatches) -> PathBuf {
+    if let Some(dir) = args.value_of("dir") {
+        // Check if path is relative from current dir, or absolute...
+        let p = Path::new(dir);
+        if p.is_relative() {
+            env::current_dir().unwrap().join(dir)
+        } else {
+            p.to_path_buf()
+        }
+    } else {
+        env::current_dir().expect("Unable to determine the current directory")
+    }
+}
+
+fn open<P: AsRef<OsStr>>(path: P) {
+    if let Err(e) = open::that(path) {
+        error!("Error opening web browser: {}", e);
+    }
+}

src/parse/mod.rs

@@ -1,3 +0,0 @@
-pub use self::summary::construct_bookitems;
-
-pub mod summary;

src/parse/summary.rs

@@ -1,225 +0,0 @@
-use std::path::PathBuf;
-use std::fs::File;
-use std::io::{Read, Result, Error, ErrorKind};
-use book::bookitem::{BookItem, Chapter};
-
-pub fn construct_bookitems(path: &PathBuf) -> Result<Vec<BookItem>> {
-    debug!("[fn]: construct_bookitems");
-    let mut summary = String::new();
-    try!(try!(File::open(path)).read_to_string(&mut summary));
-
-    debug!("[*]: Parse SUMMARY.md");
-    let top_items = try!(parse_level(&mut summary.split('\n').collect(), 0, vec![0]));
-    debug!("[*]: Done parsing SUMMARY.md");
-    Ok(top_items)
-}
-
-fn parse_level(summary: &mut Vec<&str>, current_level: i32, mut section: Vec<i32>) -> Result<Vec<BookItem>> {
-    debug!("[fn]: parse_level");
-    let mut items: Vec<BookItem> = vec![];
-
-    // Construct the book recursively
-    while !summary.is_empty() {
-        let item: BookItem;
-        // Indentation level of the line to parse
-        let level = try!(level(summary[0], 4));
-
-        // if level < current_level we remove the last digit of section, exit the current function,
-        // and return the parsed level to the calling function.
-        if level < current_level {
-            break;
-        }
-
-        // if level > current_level we call ourselves to go one level deeper
-        if level > current_level {
-            // Level can not be root level !!
-            // Add a sub-number to section
-            section.push(0);
-            let last = items.pop().expect("There should be at least one item since this can't be the root level");
-
-            if let BookItem::Chapter(ref s, ref ch) = last {
-                let mut ch = ch.clone();
-                ch.sub_items = try!(parse_level(summary, level, section.clone()));
-                items.push(BookItem::Chapter(s.clone(), ch));
-
-                // Remove the last number from the section, because we got back to our level..
-                section.pop();
-                continue;
-            } else {
-                return Err(Error::new(ErrorKind::Other,
-                                      "Your summary.md is messed up\n\n
-                        Prefix, \
-                                       Suffix and Spacer elements can only exist on the root level.\n
-                        \
-                                       Prefix elements can only exist before any chapter and there can be \
-                                       no chapters after suffix elements."));
-            };
-
-        } else {
-            // level and current_level are the same, parse the line
-            item = if let Some(parsed_item) = parse_line(summary[0]) {
-
-                // Eliminate possible errors and set section to -1 after suffix
-                match parsed_item {
-                    // error if level != 0 and BookItem is != Chapter
-                    BookItem::Affix(_) | BookItem::Spacer if level > 0 => {
-                        return Err(Error::new(ErrorKind::Other,
-                                              "Your summary.md is messed up\n\n
-                                \
-                                               Prefix, Suffix and Spacer elements can only exist on the \
-                                               root level.\n
-                                Prefix \
-                                               elements can only exist before any chapter and there can be \
-                                               no chapters after suffix elements."))
-                    },
-
-                    // error if BookItem == Chapter and section == -1
-                    BookItem::Chapter(_, _) if section[0] == -1 => {
-                        return Err(Error::new(ErrorKind::Other,
-                                              "Your summary.md is messed up\n\n
-                                \
-                                               Prefix, Suffix and Spacer elements can only exist on the \
-                                               root level.\n
-                                Prefix \
-                                               elements can only exist before any chapter and there can be \
-                                               no chapters after suffix elements."))
-                    },
-
-                    // Set section = -1 after suffix
-                    BookItem::Affix(_) if section[0] > 0 => {
-                        section[0] = -1;
-                    },
-
-                    _ => {},
-                }
-
-                match parsed_item {
-                    BookItem::Chapter(_, ch) => {
-                        // Increment section
-                        let len = section.len() - 1;
-                        section[len] += 1;
-                        let s = section.iter().fold("".to_owned(), |s, i| s + &i.to_string() + ".");
-                        BookItem::Chapter(s, ch)
-                    },
-                    _ => parsed_item,
-                }
-
-            } else {
-                // If parse_line does not return Some(_) continue...
-                summary.remove(0);
-                continue;
-            };
-        }
-
-        summary.remove(0);
-        items.push(item)
-    }
-    debug!("[*]: Level: {:?}", items);
-    Ok(items)
-}
-
-
-fn level(line: &str, spaces_in_tab: i32) -> Result<i32> {
-    debug!("[fn]: level");
-    let mut spaces = 0;
-    let mut level = 0;
-
-    for ch in line.chars() {
-        match ch {
-            ' ' => spaces += 1,
-            '\t' => level += 1,
-            _ => break,
-        }
-        if spaces >= spaces_in_tab {
-            level += 1;
-            spaces = 0;
-        }
-    }
-
-    // If there are spaces left, there is an indentation error
-    if spaces > 0 {
-        debug!("[SUMMARY.md]:");
-        debug!("\t[line]: {}", line);
-        debug!("[*]: There is an indentation error on this line. Indentation should be {} spaces", spaces_in_tab);
-        return Err(Error::new(ErrorKind::Other, format!("Indentation error on line:\n\n{}", line)));
-    }
-
-    Ok(level)
-}
-
-
-fn parse_line(l: &str) -> Option<BookItem> {
-    debug!("[fn]: parse_line");
-
-    // Remove leading and trailing spaces or tabs
-    let line = l.trim_matches(|c: char| c == ' ' || c == '\t');
-
-    // Spacers are "------"
-    if line.starts_with("--") {
-        debug!("[*]: Line is spacer");
-        return Some(BookItem::Spacer);
-    }
-
-    if let Some(c) = line.chars().nth(0) {
-        match c {
-            // List item
-            '-' | '*' => {
-                debug!("[*]: Line is list element");
-
-                if let Some((name, path)) = read_link(line) {
-                    return Some(BookItem::Chapter("0".to_owned(), Chapter::new(name, path)));
-                } else {
-                    return None;
-                }
-            },
-            // Non-list element
-            '[' => {
-                debug!("[*]: Line is a link element");
-
-                if let Some((name, path)) = read_link(line) {
-                    return Some(BookItem::Affix(Chapter::new(name, path)));
-                } else {
-                    return None;
-                }
-            },
-            _ => {},
-        }
-    }
-
-    None
-}
-
-fn read_link(line: &str) -> Option<(String, PathBuf)> {
-    let mut start_delimitor;
-    let mut end_delimitor;
-
-    // In the future, support for list item that is not a link
-    // Not sure if I should error on line I can't parse or just ignore them...
-    if let Some(i) = line.find('[') {
-        start_delimitor = i;
-    } else {
-        debug!("[*]: '[' not found, this line is not a link. Ignoring...");
-        return None;
-    }
-
-    if let Some(i) = line[start_delimitor..].find("](") {
-        end_delimitor = start_delimitor + i;
-    } else {
-        debug!("[*]: '](' not found, this line is not a link. Ignoring...");
-        return None;
-    }
-
-    let name = line[start_delimitor + 1..end_delimitor].to_owned();
-
-    start_delimitor = end_delimitor + 1;
-    if let Some(i) = line[start_delimitor..].find(')') {
-        end_delimitor = start_delimitor + i;
-    } else {
-        debug!("[*]: ')' not found, this line is not a link. Ignoring...");
-        return None;
-    }
-
-    let path = PathBuf::from(line[start_delimitor + 1..end_delimitor].to_owned());
-
-    Some((name, path))
-}

src/preprocess/cmd.rs

@@ -0,0 +1,197 @@
+use super::{Preprocessor, PreprocessorContext};
+use crate::book::Book;
+use crate::errors::*;
+use shlex::Shlex;
+use std::io::{self, Read, Write};
+use std::process::{Child, Command, Stdio};
+
+/// A custom preprocessor which will shell out to a 3rd-party program.
+///
+/// # Preprocessing Protocol
+///
+/// When the `supports_renderer()` method is executed, `CmdPreprocessor` will
+/// execute the shell command `$cmd supports $renderer`. If the renderer is
+/// supported, custom preprocessors should exit with a exit code of `0`,
+/// any other exit code be considered as unsupported.
+///
+/// The `run()` method is implemented by passing a `(PreprocessorContext, Book)`
+/// tuple to the spawned command (`$cmd`) as JSON via `stdin`. Preprocessors
+/// should then "return" a processed book by printing it to `stdout` as JSON.
+/// For convenience, the `CmdPreprocessor::parse_input()` function can be used
+/// to parse the input provided by `mdbook`.
+///
+/// Exiting with a non-zero exit code while preprocessing is considered an
+/// error. `stderr` is passed directly through to the user, so it can be used
+/// for logging or emitting warnings if desired.
+///
+/// # Examples
+///
+/// An example preprocessor is available in this project's `examples/`
+/// directory.
+#[derive(Debug, Clone, PartialEq)]
+pub struct CmdPreprocessor {
+    name: String,
+    cmd: String,
+}
+
+impl CmdPreprocessor {
+    /// Create a new `CmdPreprocessor`.
+    pub fn new(name: String, cmd: String) -> CmdPreprocessor {
+        CmdPreprocessor { name, cmd }
+    }
+
+    /// A convenience function custom preprocessors can use to parse the input
+    /// written to `stdin` by a `CmdRenderer`.
+    pub fn parse_input<R: Read>(reader: R) -> Result<(PreprocessorContext, Book)> {
+        serde_json::from_reader(reader).with_context(|| "Unable to parse the input")
+    }
+
+    fn write_input_to_child(&self, child: &mut Child, book: &Book, ctx: &PreprocessorContext) {
+        let stdin = child.stdin.take().expect("Child has stdin");
+
+        if let Err(e) = self.write_input(stdin, &book, &ctx) {
+            // Looks like the backend hung up before we could finish
+            // sending it the render context. Log the error and keep going
+            warn!("Error writing the RenderContext to the backend, {}", e);
+        }
+    }
+
+    fn write_input<W: Write>(
+        &self,
+        writer: W,
+        book: &Book,
+        ctx: &PreprocessorContext,
+    ) -> Result<()> {
+        serde_json::to_writer(writer, &(ctx, book)).map_err(Into::into)
+    }
+
+    /// The command this `Preprocessor` will invoke.
+    pub fn cmd(&self) -> &str {
+        &self.cmd
+    }
+
+    fn command(&self) -> Result<Command> {
+        let mut words = Shlex::new(&self.cmd);
+        let executable = match words.next() {
+            Some(e) => e,
+            None => bail!("Command string was empty"),
+        };
+
+        let mut cmd = Command::new(executable);
+
+        for arg in words {
+            cmd.arg(arg);
+        }
+
+        Ok(cmd)
+    }
+}
+
+impl Preprocessor for CmdPreprocessor {
+    fn name(&self) -> &str {
+        &self.name
+    }
+
+    fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book> {
+        let mut cmd = self.command()?;
+
+        let mut child = cmd
+            .stdin(Stdio::piped())
+            .stdout(Stdio::piped())
+            .stderr(Stdio::inherit())
+            .spawn()
+            .with_context(|| {
+                format!(
+                    "Unable to start the \"{}\" preprocessor. Is it installed?",
+                    self.name()
+                )
+            })?;
+
+        self.write_input_to_child(&mut child, &book, ctx);
+
+        let output = child
+            .wait_with_output()
+            .with_context(|| "Error waiting for the preprocessor to complete")?;
+
+        trace!("{} exited with output: {:?}", self.cmd, output);
+        ensure!(
+            output.status.success(),
+            "The preprocessor exited unsuccessfully"
+        );
+
+        serde_json::from_slice(&output.stdout)
+            .with_context(|| "Unable to parse the preprocessed book")
+    }
+
+    fn supports_renderer(&self, renderer: &str) -> bool {
+        debug!(
+            "Checking if the \"{}\" preprocessor supports \"{}\"",
+            self.name(),
+            renderer
+        );
+
+        let mut cmd = match self.command() {
+            Ok(c) => c,
+            Err(e) => {
+                warn!(
+                    "Unable to create the command for the \"{}\" preprocessor, {}",
+                    self.name(),
+                    e
+                );
+                return false;
+            }
+        };
+
+        let outcome = cmd
+            .arg("supports")
+            .arg(renderer)
+            .stdin(Stdio::null())
+            .stdout(Stdio::inherit())
+            .stderr(Stdio::inherit())
+            .status()
+            .map(|status| status.code() == Some(0));
+
+        if let Err(ref e) = outcome {
+            if e.kind() == io::ErrorKind::NotFound {
+                warn!(
+                    "The command wasn't found, is the \"{}\" preprocessor installed?",
+                    self.name
+                );
+                warn!("\tCommand: {}", self.cmd);
+            }
+        }
+
+        outcome.unwrap_or(false)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::MDBook;
+    use std::path::Path;
+
+    fn guide() -> MDBook {
+        let example = Path::new(env!("CARGO_MANIFEST_DIR")).join("guide");
+        MDBook::load(example).unwrap()
+    }
+
+    #[test]
+    fn round_trip_write_and_parse_input() {
+        let cmd = CmdPreprocessor::new("test".to_string(), "test".to_string());
+        let md = guide();
+        let ctx = PreprocessorContext::new(
+            md.root.clone(),
+            md.config.clone(),
+            "some-renderer".to_string(),
+        );
+
+        let mut buffer = Vec::new();
+        cmd.write_input(&mut buffer, &md.book, &ctx).unwrap();
+
+        let (got_ctx, got_book) = CmdPreprocessor::parse_input(buffer.as_slice()).unwrap();
+
+        assert_eq!(got_book, md.book);
+        assert_eq!(got_ctx, ctx);
+    }
+}

src/preprocess/index.rs

@@ -0,0 +1,105 @@
+use regex::Regex;
+use std::path::Path;
+
+use crate::errors::*;
+
+use super::{Preprocessor, PreprocessorContext};
+use crate::book::{Book, BookItem};
+
+/// A preprocessor for converting file name `README.md` to `index.md` since
+/// `README.md` is the de facto index file in markdown-based documentation.
+#[derive(Default)]
+pub struct IndexPreprocessor;
+
+impl IndexPreprocessor {
+    pub(crate) const NAME: &'static str = "index";
+
+    /// Create a new `IndexPreprocessor`.
+    pub fn new() -> Self {
+        IndexPreprocessor
+    }
+}
+
+impl Preprocessor for IndexPreprocessor {
+    fn name(&self) -> &str {
+        Self::NAME
+    }
+
+    fn run(&self, ctx: &PreprocessorContext, mut book: Book) -> Result<Book> {
+        let source_dir = ctx.root.join(&ctx.config.book.src);
+        book.for_each_mut(|section: &mut BookItem| {
+            if let BookItem::Chapter(ref mut ch) = *section {
+                if let Some(ref mut path) = ch.path {
+                    if is_readme_file(&path) {
+                        let mut index_md = source_dir.join(path.with_file_name("index.md"));
+                        if index_md.exists() {
+                            warn_readme_name_conflict(&path, &&mut index_md);
+                        }
+
+                        path.set_file_name("index.md");
+                    }
+                }
+            }
+        });
+
+        Ok(book)
+    }
+}
+
+fn warn_readme_name_conflict<P: AsRef<Path>>(readme_path: P, index_path: P) {
+    let file_name = readme_path.as_ref().file_name().unwrap_or_default();
+    let parent_dir = index_path
+        .as_ref()
+        .parent()
+        .unwrap_or_else(|| index_path.as_ref());
+    warn!(
+        "It seems that there are both {:?} and index.md under \"{}\".",
+        file_name,
+        parent_dir.display()
+    );
+    warn!(
+        "mdbook converts {:?} into index.html by default. It may cause",
+        file_name
+    );
+    warn!("unexpected behavior if putting both files under the same directory.");
+    warn!("To solve the warning, try to rearrange the book structure or disable");
+    warn!("\"index\" preprocessor to stop the conversion.");
+}
+
+fn is_readme_file<P: AsRef<Path>>(path: P) -> bool {
+    lazy_static! {
+        static ref RE: Regex = Regex::new(r"(?i)^readme$").unwrap();
+    }
+    RE.is_match(
+        path.as_ref()
+            .file_stem()
+            .and_then(std::ffi::OsStr::to_str)
+            .unwrap_or_default(),
+    )
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn file_stem_exactly_matches_readme_case_insensitively() {
+        let path = "path/to/Readme.md";
+        assert!(is_readme_file(path));
+
+        let path = "path/to/README.md";
+        assert!(is_readme_file(path));
+
+        let path = "path/to/rEaDmE.md";
+        assert!(is_readme_file(path));
+
+        let path = "path/to/README.markdown";
+        assert!(is_readme_file(path));
+
+        let path = "path/to/README";
+        assert!(is_readme_file(path));
+
+        let path = "path/to/README-README.md";
+        assert!(!is_readme_file(path));
+    }
+}

src/preprocess/links.rs

@@ -0,0 +1,886 @@
+use crate::errors::*;
+use crate::utils::{
+    take_anchored_lines, take_lines, take_rustdoc_include_anchored_lines,
+    take_rustdoc_include_lines,
+};
+use regex::{CaptureMatches, Captures, Regex};
+use std::fs;
+use std::ops::{Bound, Range, RangeBounds, RangeFrom, RangeFull, RangeTo};
+use std::path::{Path, PathBuf};
+
+use super::{Preprocessor, PreprocessorContext};
+use crate::book::{Book, BookItem};
+
+const ESCAPE_CHAR: char = '\\';
+const MAX_LINK_NESTED_DEPTH: usize = 10;
+
+/// A preprocessor for expanding helpers in a chapter. Supported helpers are:
+///
+/// - `{{# include}}` - Insert an external file of any type. Include the whole file, only particular
+///.  lines, or only between the specified anchors.
+/// - `{{# rustdoc_include}}` - Insert an external Rust file, showing the particular lines
+///.  specified or the lines between specified anchors, and include the rest of the file behind `#`.
+///   This hides the lines from initial display but shows them when the reader expands the code
+///   block and provides them to Rustdoc for testing.
+/// - `{{# playground}}` - Insert runnable Rust files
+#[derive(Default)]
+pub struct LinkPreprocessor;
+
+impl LinkPreprocessor {
+    pub(crate) const NAME: &'static str = "links";
+
+    /// Create a new `LinkPreprocessor`.
+    pub fn new() -> Self {
+        LinkPreprocessor
+    }
+}
+
+impl Preprocessor for LinkPreprocessor {
+    fn name(&self) -> &str {
+        Self::NAME
+    }
+
+    fn run(&self, ctx: &PreprocessorContext, mut book: Book) -> Result<Book> {
+        let src_dir = ctx.root.join(&ctx.config.book.src);
+
+        book.for_each_mut(|section: &mut BookItem| {
+            if let BookItem::Chapter(ref mut ch) = *section {
+                if let Some(ref chapter_path) = ch.path {
+                    let base = chapter_path
+                        .parent()
+                        .map(|dir| src_dir.join(dir))
+                        .expect("All book items have a parent");
+
+                    let content = replace_all(&ch.content, base, chapter_path, 0);
+                    ch.content = content;
+                }
+            }
+        });
+
+        Ok(book)
+    }
+}
+
+fn replace_all<P1, P2>(s: &str, path: P1, source: P2, depth: usize) -> String
+where
+    P1: AsRef<Path>,
+    P2: AsRef<Path>,
+{
+    // When replacing one thing in a string by something with a different length,
+    // the indices after that will not correspond,
+    // we therefore have to store the difference to correct this
+    let path = path.as_ref();
+    let source = source.as_ref();
+    let mut previous_end_index = 0;
+    let mut replaced = String::new();
+
+    for link in find_links(s) {
+        replaced.push_str(&s[previous_end_index..link.start_index]);
+
+        match link.render_with_path(&path) {
+            Ok(new_content) => {
+                if depth < MAX_LINK_NESTED_DEPTH {
+                    if let Some(rel_path) = link.link_type.relative_path(path) {
+                        replaced.push_str(&replace_all(&new_content, rel_path, source, depth + 1));
+                    } else {
+                        replaced.push_str(&new_content);
+                    }
+                } else {
+                    error!(
+                        "Stack depth exceeded in {}. Check for cyclic includes",
+                        source.display()
+                    );
+                }
+                previous_end_index = link.end_index;
+            }
+            Err(e) => {
+                error!("Error updating \"{}\", {}", link.link_text, e);
+                for cause in e.chain().skip(1) {
+                    warn!("Caused By: {}", cause);
+                }
+
+                // This should make sure we include the raw `{{# ... }}` snippet
+                // in the page content if there are any errors.
+                previous_end_index = link.start_index;
+            }
+        }
+    }
+
+    replaced.push_str(&s[previous_end_index..]);
+    replaced
+}
+
+#[derive(PartialEq, Debug, Clone)]
+enum LinkType<'a> {
+    Escaped,
+    Include(PathBuf, RangeOrAnchor),
+    Playground(PathBuf, Vec<&'a str>),
+    RustdocInclude(PathBuf, RangeOrAnchor),
+}
+
+#[derive(PartialEq, Debug, Clone)]
+enum RangeOrAnchor {
+    Range(LineRange),
+    Anchor(String),
+}
+
+// A range of lines specified with some include directive.
+#[derive(PartialEq, Debug, Clone)]
+enum LineRange {
+    Range(Range<usize>),
+    RangeFrom(RangeFrom<usize>),
+    RangeTo(RangeTo<usize>),
+    RangeFull(RangeFull),
+}
+
+impl RangeBounds<usize> for LineRange {
+    fn start_bound(&self) -> Bound<&usize> {
+        match self {
+            LineRange::Range(r) => r.start_bound(),
+            LineRange::RangeFrom(r) => r.start_bound(),
+            LineRange::RangeTo(r) => r.start_bound(),
+            LineRange::RangeFull(r) => r.start_bound(),
+        }
+    }
+
+    fn end_bound(&self) -> Bound<&usize> {
+        match self {
+            LineRange::Range(r) => r.end_bound(),
+            LineRange::RangeFrom(r) => r.end_bound(),
+            LineRange::RangeTo(r) => r.end_bound(),
+            LineRange::RangeFull(r) => r.end_bound(),
+        }
+    }
+}
+
+impl From<Range<usize>> for LineRange {
+    fn from(r: Range<usize>) -> LineRange {
+        LineRange::Range(r)
+    }
+}
+
+impl From<RangeFrom<usize>> for LineRange {
+    fn from(r: RangeFrom<usize>) -> LineRange {
+        LineRange::RangeFrom(r)
+    }
+}
+
+impl From<RangeTo<usize>> for LineRange {
+    fn from(r: RangeTo<usize>) -> LineRange {
+        LineRange::RangeTo(r)
+    }
+}
+
+impl From<RangeFull> for LineRange {
+    fn from(r: RangeFull) -> LineRange {
+        LineRange::RangeFull(r)
+    }
+}
+
+impl<'a> LinkType<'a> {
+    fn relative_path<P: AsRef<Path>>(self, base: P) -> Option<PathBuf> {
+        let base = base.as_ref();
+        match self {
+            LinkType::Escaped => None,
+            LinkType::Include(p, _) => Some(return_relative_path(base, &p)),
+            LinkType::Playground(p, _) => Some(return_relative_path(base, &p)),
+            LinkType::RustdocInclude(p, _) => Some(return_relative_path(base, &p)),
+        }
+    }
+}
+fn return_relative_path<P: AsRef<Path>>(base: P, relative: P) -> PathBuf {
+    base.as_ref()
+        .join(relative)
+        .parent()
+        .expect("Included file should not be /")
+        .to_path_buf()
+}
+
+fn parse_range_or_anchor(parts: Option<&str>) -> RangeOrAnchor {
+    let mut parts = parts.unwrap_or("").splitn(3, ':').fuse();
+
+    let next_element = parts.next();
+    let start = if let Some(value) = next_element.and_then(|s| s.parse::<usize>().ok()) {
+        // subtract 1 since line numbers usually begin with 1
+        Some(value.saturating_sub(1))
+    } else if let Some("") = next_element {
+        None
+    } else if let Some(anchor) = next_element {
+        return RangeOrAnchor::Anchor(String::from(anchor));
+    } else {
+        None
+    };
+
+    let end = parts.next();
+    // If `end` is empty string or any other value that can't be parsed as a usize, treat this
+    // include as a range with only a start bound. However, if end isn't specified, include only
+    // the single line specified by `start`.
+    let end = end.map(|s| s.parse::<usize>());
+
+    match (start, end) {
+        (Some(start), Some(Ok(end))) => RangeOrAnchor::Range(LineRange::from(start..end)),
+        (Some(start), Some(Err(_))) => RangeOrAnchor::Range(LineRange::from(start..)),
+        (Some(start), None) => RangeOrAnchor::Range(LineRange::from(start..start + 1)),
+        (None, Some(Ok(end))) => RangeOrAnchor::Range(LineRange::from(..end)),
+        (None, None) | (None, Some(Err(_))) => RangeOrAnchor::Range(LineRange::from(RangeFull)),
+    }
+}
+
+fn parse_include_path(path: &str) -> LinkType<'static> {
+    let mut parts = path.splitn(2, ':');
+
+    let path = parts.next().unwrap().into();
+    let range_or_anchor = parse_range_or_anchor(parts.next());
+
+    LinkType::Include(path, range_or_anchor)
+}
+
+fn parse_rustdoc_include_path(path: &str) -> LinkType<'static> {
+    let mut parts = path.splitn(2, ':');
+
+    let path = parts.next().unwrap().into();
+    let range_or_anchor = parse_range_or_anchor(parts.next());
+
+    LinkType::RustdocInclude(path, range_or_anchor)
+}
+
+#[derive(PartialEq, Debug, Clone)]
+struct Link<'a> {
+    start_index: usize,
+    end_index: usize,
+    link_type: LinkType<'a>,
+    link_text: &'a str,
+}
+
+impl<'a> Link<'a> {
+    fn from_capture(cap: Captures<'a>) -> Option<Link<'a>> {
+        let link_type = match (cap.get(0), cap.get(1), cap.get(2)) {
+            (_, Some(typ), Some(rest)) => {
+                let mut path_props = rest.as_str().split_whitespace();
+                let file_arg = path_props.next();
+                let props: Vec<&str> = path_props.collect();
+
+                match (typ.as_str(), file_arg) {
+                    ("include", Some(pth)) => Some(parse_include_path(pth)),
+                    ("playground", Some(pth)) => Some(LinkType::Playground(pth.into(), props)),
+                    ("playpen", Some(pth)) => {
+                        warn!(
+                            "the {{{{#playpen}}}} expression has been \
+                            renamed to {{{{#playground}}}}, \
+                            please update your book to use the new name"
+                        );
+                        Some(LinkType::Playground(pth.into(), props))
+                    }
+                    ("rustdoc_include", Some(pth)) => Some(parse_rustdoc_include_path(pth)),
+                    _ => None,
+                }
+            }
+            (Some(mat), None, None) if mat.as_str().starts_with(ESCAPE_CHAR) => {
+                Some(LinkType::Escaped)
+            }
+            _ => None,
+        };
+
+        link_type.and_then(|lnk_type| {
+            cap.get(0).map(|mat| Link {
+                start_index: mat.start(),
+                end_index: mat.end(),
+                link_type: lnk_type,
+                link_text: mat.as_str(),
+            })
+        })
+    }
+
+    fn render_with_path<P: AsRef<Path>>(&self, base: P) -> Result<String> {
+        let base = base.as_ref();
+        match self.link_type {
+            // omit the escape char
+            LinkType::Escaped => Ok((&self.link_text[1..]).to_owned()),
+            LinkType::Include(ref pat, ref range_or_anchor) => {
+                let target = base.join(pat);
+
+                fs::read_to_string(&target)
+                    .map(|s| match range_or_anchor {
+                        RangeOrAnchor::Range(range) => take_lines(&s, range.clone()),
+                        RangeOrAnchor::Anchor(anchor) => take_anchored_lines(&s, anchor),
+                    })
+                    .with_context(|| {
+                        format!(
+                            "Could not read file for link {} ({})",
+                            self.link_text,
+                            target.display(),
+                        )
+                    })
+            }
+            LinkType::RustdocInclude(ref pat, ref range_or_anchor) => {
+                let target = base.join(pat);
+
+                fs::read_to_string(&target)
+                    .map(|s| match range_or_anchor {
+                        RangeOrAnchor::Range(range) => {
+                            take_rustdoc_include_lines(&s, range.clone())
+                        }
+                        RangeOrAnchor::Anchor(anchor) => {
+                            take_rustdoc_include_anchored_lines(&s, anchor)
+                        }
+                    })
+                    .with_context(|| {
+                        format!(
+                            "Could not read file for link {} ({})",
+                            self.link_text,
+                            target.display(),
+                        )
+                    })
+            }
+            LinkType::Playground(ref pat, ref attrs) => {
+                let target = base.join(pat);
+
+                let contents = fs::read_to_string(&target).with_context(|| {
+                    format!(
+                        "Could not read file for link {} ({})",
+                        self.link_text,
+                        target.display()
+                    )
+                })?;
+                let ftype = if !attrs.is_empty() { "rust," } else { "rust" };
+                Ok(format!(
+                    "```{}{}\n{}\n```\n",
+                    ftype,
+                    attrs.join(","),
+                    contents
+                ))
+            }
+        }
+    }
+}
+
+struct LinkIter<'a>(CaptureMatches<'a, 'a>);
+
+impl<'a> Iterator for LinkIter<'a> {
+    type Item = Link<'a>;
+    fn next(&mut self) -> Option<Link<'a>> {
+        for cap in &mut self.0 {
+            if let Some(inc) = Link::from_capture(cap) {
+                return Some(inc);
+            }
+        }
+        None
+    }
+}
+
+fn find_links(contents: &str) -> LinkIter<'_> {
+    // lazily compute following regex
+    // r"\\\{\{#.*\}\}|\{\{#([a-zA-Z0-9]+)\s*([a-zA-Z0-9_.\-:/\\\s]+)\}\}")?;
+    lazy_static! {
+        static ref RE: Regex = Regex::new(
+            r"(?x)                       # insignificant whitespace mode
+            \\\{\{\#.*\}\}               # match escaped link
+            |                            # or
+            \{\{\s*                      # link opening parens and whitespace
+            \#([a-zA-Z0-9_]+)            # link type
+            \s+                          # separating whitespace
+            ([a-zA-Z0-9\s_.\-:/\\\+]+)   # link target path and space separated properties
+            \s*\}\}                      # whitespace and link closing parens"
+        )
+        .unwrap();
+    }
+    LinkIter(RE.captures_iter(contents))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_replace_all_escaped() {
+        let start = r"
+        Some text over here.
+        ```hbs
+        \{{#include file.rs}} << an escaped link!
+        ```";
+        let end = r"
+        Some text over here.
+        ```hbs
+        {{#include file.rs}} << an escaped link!
+        ```";
+        assert_eq!(replace_all(start, "", "", 0), end);
+    }
+
+    #[test]
+    fn test_find_links_no_link() {
+        let s = "Some random text without link...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+    }
+
+    #[test]
+    fn test_find_links_partial_link() {
+        let s = "Some random text with {{#playground...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+        let s = "Some random text with {{#include...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+        let s = "Some random text with \\{{#include...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+    }
+
+    #[test]
+    fn test_find_links_empty_link() {
+        let s = "Some random text with {{#playground}} and {{#playground   }} {{}} {{#}}...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+    }
+
+    #[test]
+    fn test_find_links_unknown_link_type() {
+        let s = "Some random text with {{#playgroundz ar.rs}} and {{#incn}} {{baz}} {{#bar}}...";
+        assert!(find_links(s).collect::<Vec<_>>() == vec![]);
+    }
+
+    #[test]
+    fn test_find_links_simple_link() {
+        let s = "Some random text with {{#playground file.rs}} and {{#playground test.rs }}...";
+
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+
+        assert_eq!(
+            res,
+            vec![
+                Link {
+                    start_index: 22,
+                    end_index: 45,
+                    link_type: LinkType::Playground(PathBuf::from("file.rs"), vec![]),
+                    link_text: "{{#playground file.rs}}",
+                },
+                Link {
+                    start_index: 50,
+                    end_index: 74,
+                    link_type: LinkType::Playground(PathBuf::from("test.rs"), vec![]),
+                    link_text: "{{#playground test.rs }}",
+                },
+            ]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_special_characters() {
+        let s = "Some random text with {{#playground foo-bar\\baz/_c++.rs}}...";
+
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 57,
+                link_type: LinkType::Playground(PathBuf::from("foo-bar\\baz/_c++.rs"), vec![]),
+                link_text: "{{#playground foo-bar\\baz/_c++.rs}}",
+            },]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_range() {
+        let s = "Some random text with {{#include file.rs:10:20}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 48,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(9..20))
+                ),
+                link_text: "{{#include file.rs:10:20}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_line_number() {
+        let s = "Some random text with {{#include file.rs:10}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 45,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(9..10))
+                ),
+                link_text: "{{#include file.rs:10}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_from_range() {
+        let s = "Some random text with {{#include file.rs:10:}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 46,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(9..))
+                ),
+                link_text: "{{#include file.rs:10:}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_to_range() {
+        let s = "Some random text with {{#include file.rs::20}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 46,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(..20))
+                ),
+                link_text: "{{#include file.rs::20}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_full_range() {
+        let s = "Some random text with {{#include file.rs::}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 44,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(..))
+                ),
+                link_text: "{{#include file.rs::}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_no_range_specified() {
+        let s = "Some random text with {{#include file.rs}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 42,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(..))
+                ),
+                link_text: "{{#include file.rs}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_with_anchor() {
+        let s = "Some random text with {{#include file.rs:anchor}}...";
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 22,
+                end_index: 49,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Anchor(String::from("anchor"))
+                ),
+                link_text: "{{#include file.rs:anchor}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_links_escaped_link() {
+        let s = "Some random text with escaped playground \\{{#playground file.rs editable}} ...";
+
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+
+        assert_eq!(
+            res,
+            vec![Link {
+                start_index: 41,
+                end_index: 74,
+                link_type: LinkType::Escaped,
+                link_text: "\\{{#playground file.rs editable}}",
+            }]
+        );
+    }
+
+    #[test]
+    fn test_find_playgrounds_with_properties() {
+        let s =
+            "Some random text with escaped playground {{#playground file.rs editable }} and some \
+                 more\n text {{#playground my.rs editable no_run should_panic}} ...";
+
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(
+            res,
+            vec![
+                Link {
+                    start_index: 41,
+                    end_index: 74,
+                    link_type: LinkType::Playground(PathBuf::from("file.rs"), vec!["editable"]),
+                    link_text: "{{#playground file.rs editable }}",
+                },
+                Link {
+                    start_index: 95,
+                    end_index: 145,
+                    link_type: LinkType::Playground(
+                        PathBuf::from("my.rs"),
+                        vec!["editable", "no_run", "should_panic"],
+                    ),
+                    link_text: "{{#playground my.rs editable no_run should_panic}}",
+                },
+            ]
+        );
+    }
+
+    #[test]
+    fn test_find_all_link_types() {
+        let s =
+            "Some random text with escaped playground {{#include file.rs}} and \\{{#contents are \
+                 insignifficant in escaped link}} some more\n text  {{#playground my.rs editable \
+                 no_run should_panic}} ...";
+
+        let res = find_links(s).collect::<Vec<_>>();
+        println!("\nOUTPUT: {:?}\n", res);
+        assert_eq!(res.len(), 3);
+        assert_eq!(
+            res[0],
+            Link {
+                start_index: 41,
+                end_index: 61,
+                link_type: LinkType::Include(
+                    PathBuf::from("file.rs"),
+                    RangeOrAnchor::Range(LineRange::from(..))
+                ),
+                link_text: "{{#include file.rs}}",
+            }
+        );
+        assert_eq!(
+            res[1],
+            Link {
+                start_index: 66,
+                end_index: 115,
+                link_type: LinkType::Escaped,
+                link_text: "\\{{#contents are insignifficant in escaped link}}",
+            }
+        );
+        assert_eq!(
+            res[2],
+            Link {
+                start_index: 133,
+                end_index: 183,
+                link_type: LinkType::Playground(
+                    PathBuf::from("my.rs"),
+                    vec!["editable", "no_run", "should_panic"]
+                ),
+                link_text: "{{#playground my.rs editable no_run should_panic}}",
+            }
+        );
+    }
+
+    #[test]
+    fn parse_without_colon_includes_all() {
+        let link_type = parse_include_path("arbitrary");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(RangeFull))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_nothing_after_colon_includes_all() {
+        let link_type = parse_include_path("arbitrary:");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(RangeFull))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_two_colons_includes_all() {
+        let link_type = parse_include_path("arbitrary::");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(RangeFull))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_garbage_after_two_colons_includes_all() {
+        let link_type = parse_include_path("arbitrary::NaN");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(RangeFull))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_one_number_after_colon_only_that_line() {
+        let link_type = parse_include_path("arbitrary:5");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(4..5))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_one_based_start_becomes_zero_based() {
+        let link_type = parse_include_path("arbitrary:1");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(0..1))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_zero_based_start_stays_zero_based_but_is_probably_an_error() {
+        let link_type = parse_include_path("arbitrary:0");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(0..1))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_start_only_range() {
+        let link_type = parse_include_path("arbitrary:5:");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(4..))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_start_with_garbage_interpreted_as_start_only_range() {
+        let link_type = parse_include_path("arbitrary:5:NaN");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(4..))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_end_only_range() {
+        let link_type = parse_include_path("arbitrary::5");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(..5))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_start_and_end_range() {
+        let link_type = parse_include_path("arbitrary:5:10");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(4..10))
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_negative_interpreted_as_anchor() {
+        let link_type = parse_include_path("arbitrary:-5");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Anchor("-5".to_string())
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_floating_point_interpreted_as_anchor() {
+        let link_type = parse_include_path("arbitrary:-5.7");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Anchor("-5.7".to_string())
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_anchor_followed_by_colon() {
+        let link_type = parse_include_path("arbitrary:some-anchor:this-gets-ignored");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Anchor("some-anchor".to_string())
+            )
+        );
+    }
+
+    #[test]
+    fn parse_with_more_than_three_colons_ignores_everything_after_third_colon() {
+        let link_type = parse_include_path("arbitrary:5:10:17:anything:");
+        assert_eq!(
+            link_type,
+            LinkType::Include(
+                PathBuf::from("arbitrary"),
+                RangeOrAnchor::Range(LineRange::from(4..10))
+            )
+        );
+    }
+}

src/preprocess/mod.rs

@@ -0,0 +1,63 @@
+//! Book preprocessing.
+
+pub use self::cmd::CmdPreprocessor;
+pub use self::index::IndexPreprocessor;
+pub use self::links::LinkPreprocessor;
+
+mod cmd;
+mod index;
+mod links;
+
+use crate::book::Book;
+use crate::config::Config;
+use crate::errors::*;
+
+use std::path::PathBuf;
+
+/// Extra information for a `Preprocessor` to give them more context when
+/// processing a book.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+pub struct PreprocessorContext {
+    /// The location of the book directory on disk.
+    pub root: PathBuf,
+    /// The book configuration (`book.toml`).
+    pub config: Config,
+    /// The `Renderer` this preprocessor is being used with.
+    pub renderer: String,
+    /// The calling `mdbook` version.
+    pub mdbook_version: String,
+    #[serde(skip)]
+    __non_exhaustive: (),
+}
+
+impl PreprocessorContext {
+    /// Create a new `PreprocessorContext`.
+    pub(crate) fn new(root: PathBuf, config: Config, renderer: String) -> Self {
+        PreprocessorContext {
+            root,
+            config,
+            renderer,
+            mdbook_version: crate::MDBOOK_VERSION.to_string(),
+            __non_exhaustive: (),
+        }
+    }
+}
+
+/// An operation which is run immediately after loading a book into memory and
+/// before it gets rendered.
+pub trait Preprocessor {
+    /// Get the `Preprocessor`'s name.
+    fn name(&self) -> &str;
+
+    /// Run this `Preprocessor`, allowing it to update the book before it is
+    /// given to a renderer.
+    fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book>;
+
+    /// A hint to `MDBook` whether this preprocessor is compatible with a
+    /// particular renderer.
+    ///
+    /// By default, always returns `true`.
+    fn supports_renderer(&self, _renderer: &str) -> bool {
+        true
+    }
+}

src/renderer/html_handlebars/helpers/mod.rs

@@ -1,3 +1,3 @@
 pub mod navigation;
+pub mod theme;
 pub mod toc;
-pub mod playpen;

src/renderer/html_handlebars/helpers/navigation.rs

@@ -1,200 +1,290 @@
+use std::collections::BTreeMap;
 use std::path::Path;
-use std::collections::{VecDeque, BTreeMap};
 
-use serde_json;
-use handlebars::{Handlebars, RenderError, RenderContext, Helper, Renderable};
+use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError, Renderable};
 
+use crate::utils;
 
-// Handlebars helper for navigation
+type StringMap = BTreeMap<String, String>;
 
-pub fn previous(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
-    debug!("[fn]: previous (handlebars helper)");
-
-    debug!("[*]: Get data from context");
-    // get value from context data
-    // rc.get_path() is current json parent path, you should always use it like this
-    // param is the key of value you want to display
-    let chapters = rc.context().navigate(rc.get_path(), &VecDeque::new(), "chapters").to_owned();
-
-    let current = rc.context().navigate(rc.get_path(), &VecDeque::new(), "path")
-        .to_string()
-        .replace("\"", "");
-
-
-    debug!("[*]: Decode chapters from JSON");
-    // Decode json format
-    let decoded: Vec<BTreeMap<String, String>> = match serde_json::from_str(&chapters.to_string()) {
-        Ok(data) => data,
-        Err(_) => return Err(RenderError::new("Could not decode the JSON data")),
-    };
-    let mut previous: Option<BTreeMap<String, String>> = None;
-
-
-    debug!("[*]: Search for current Chapter");
-    // Search for current chapter and return previous entry
-    for item in decoded {
-
-        match item.get("path") {
-            Some(path) if !path.is_empty() => {
-                if path == &current {
-
-                    debug!("[*]: Found current chapter");
-                    if let Some(previous) = previous {
-
-                        debug!("[*]: Creating BTreeMap to inject in context");
-                        // Create new BTreeMap to extend the context: 'title' and 'link'
-                        let mut previous_chapter = BTreeMap::new();
-
-                        // Chapter title
-                        match previous.get("name") {
-                            Some(n) => {
-                                debug!("[*]: Inserting title: {}", n);
-                                previous_chapter.insert("title".to_owned(), json!(n))
-                            },
-                            None => {
-                                debug!("[*]: No title found for chapter");
-                                return Err(RenderError::new("No title found for chapter in JSON data"));
-                            },
-                        };
-
-                        // Chapter link
-
-                        match previous.get("path") {
-                            Some(p) => {
-                                // Hack for windows who tends to use `\` as separator instead of `/`
-                                let path = Path::new(p).with_extension("html");
-                                debug!("[*]: Inserting link: {:?}", path);
-
-                                match path.to_str() {
-                                    Some(p) => {
-                                        previous_chapter.insert("link".to_owned(), json!(p.replace("\\", "/")));
-                                    },
-                                    None => return Err(RenderError::new("Link could not be converted to str")),
-                                }
-                            },
-                            None => return Err(RenderError::new("No path found for chapter in JSON data")),
-                        }
-
-                        debug!("[*]: Inject in context");
-                        // Inject in current context
-                        let updated_context = rc.context().extend(&previous_chapter);
-
-                        debug!("[*]: Render template");
-                        // Render template
-                        match _h.template() {
-                            Some(t) => {
-                                *rc.context_mut() = updated_context;
-                                try!(t.render(r, rc));
-                            },
-                            None => return Err(RenderError::new("Error with the handlebars template")),
-                        }
-
-                    }
-
-                    break;
-                } else {
-                    previous = Some(item.clone());
-                }
-            },
-            _ => continue,
-
-        }
-
-    }
-
-    Ok(())
+/// Target for `find_chapter`.
+enum Target {
+    Previous,
+    Next,
 }
 
+impl Target {
+    /// Returns target if found.
+    fn find(
+        &self,
+        base_path: &str,
+        current_path: &str,
+        current_item: &StringMap,
+        previous_item: &StringMap,
+    ) -> Result<Option<StringMap>, RenderError> {
+        match *self {
+            Target::Next => {
+                let previous_path = previous_item
+                    .get("path")
+                    .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))?;
 
+                if previous_path == base_path {
+                    return Ok(Some(current_item.clone()));
+                }
+            }
 
+            Target::Previous => {
+                if current_path == base_path {
+                    return Ok(Some(previous_item.clone()));
+                }
+            }
+        }
 
-pub fn next(_h: &Helper, r: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
-    debug!("[fn]: next (handlebars helper)");
+        Ok(None)
+    }
+}
 
-    debug!("[*]: Get data from context");
-    // get value from context data
-    // rc.get_path() is current json parent path, you should always use it like this
-    // param is the key of value you want to display
-    let chapters = rc.context().navigate(rc.get_path(), &VecDeque::new(), "chapters").to_owned();
+fn find_chapter(
+    ctx: &Context,
+    rc: &mut RenderContext<'_, '_>,
+    target: Target,
+) -> Result<Option<StringMap>, RenderError> {
+    debug!("Get data from context");
 
-    let current = rc.context().navigate(rc.get_path(), &VecDeque::new(), "path")
-        .to_string()
+    let chapters = rc.evaluate(ctx, "@root/chapters").and_then(|c| {
+        serde_json::value::from_value::<Vec<StringMap>>(c.as_json().clone())
+            .map_err(|_| RenderError::new("Could not decode the JSON data"))
+    })?;
+
+    let base_path = rc
+        .evaluate(ctx, "@root/path")?
+        .as_json()
+        .as_str()
+        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
         .replace("\"", "");
 
-    debug!("[*]: Decode chapters from JSON");
-    // Decode json format
-    let decoded: Vec<BTreeMap<String, String>> = match serde_json::from_str(&chapters.to_string()) {
-        Ok(data) => data,
-        Err(_) => return Err(RenderError::new("Could not decode the JSON data")),
-    };
-    let mut previous: Option<BTreeMap<String, String>> = None;
+    if !rc.evaluate(ctx, "@root/is_index")?.is_missing() {
+        // Special case for index.md which may be a synthetic page.
+        // Target::find won't match because there is no page with the path
+        // "index.md" (unless there really is an index.md in SUMMARY.md).
+        match target {
+            Target::Previous => return Ok(None),
+            Target::Next => match chapters
+                .iter()
+                .filter(|chapter| {
+                    // Skip things like "spacer"
+                    chapter.contains_key("path")
+                })
+                .nth(1)
+            {
+                Some(chapter) => return Ok(Some(chapter.clone())),
+                None => return Ok(None),
+            },
+        }
+    }
 
-    debug!("[*]: Search for current Chapter");
-    // Search for current chapter and return previous entry
-    for item in decoded {
+    let mut previous: Option<StringMap> = None;
 
+    debug!("Search for chapter");
+
+    for item in chapters {
         match item.get("path") {
-
             Some(path) if !path.is_empty() => {
-
                 if let Some(previous) = previous {
-
-                    let previous_path = match previous.get("path") {
-                        Some(p) => p,
-                        None => return Err(RenderError::new("No path found for chapter in JSON data")),
-                    };
-
-                    if previous_path == &current {
-
-                        debug!("[*]: Found current chapter");
-                        debug!("[*]: Creating BTreeMap to inject in context");
-                        // Create new BTreeMap to extend the context: 'title' and 'link'
-                        let mut next_chapter = BTreeMap::new();
-
-                        match item.get("name") {
-                            Some(n) => {
-                                debug!("[*]: Inserting title: {}", n);
-                                next_chapter.insert("title".to_owned(), json!(n));
-                            },
-                            None => return Err(RenderError::new("No title found for chapter in JSON data")),
-                        }
-
-
-                        let link = Path::new(path).with_extension("html");
-                        debug!("[*]: Inserting link: {:?}", link);
-
-                        match link.to_str() {
-                            Some(l) => {
-                                // Hack for windows who tends to use `\` as separator instead of `/`
-                                next_chapter.insert("link".to_owned(), json!(l.replace("\\", "/")));
-                            },
-                            None => return Err(RenderError::new("Link could not converted to str")),
-                        }
-
-                        debug!("[*]: Inject in context");
-                        // Inject in current context
-                        let updated_context = rc.context().extend(&next_chapter);
-
-                        debug!("[*]: Render template");
-
-                        // Render template
-                        match _h.template() {
-                            Some(t) => {
-                                *rc.context_mut() = updated_context;
-                                try!(t.render(r, rc));
-                            },
-                            None => return Err(RenderError::new("Error with the handlebars template")),
-                        }
-
-                        break;
+                    if let Some(item) = target.find(&base_path, &path, &item, &previous)? {
+                        return Ok(Some(item));
                     }
                 }
 
                 previous = Some(item.clone());
-            },
-
+            }
             _ => continue,
         }
     }
+
+    Ok(None)
+}
+
+fn render(
+    _h: &Helper<'_, '_>,
+    r: &Handlebars<'_>,
+    ctx: &Context,
+    rc: &mut RenderContext<'_, '_>,
+    out: &mut dyn Output,
+    chapter: &StringMap,
+) -> Result<(), RenderError> {
+    trace!("Creating BTreeMap to inject in context");
+
+    let mut context = BTreeMap::new();
+    let base_path = rc
+        .evaluate(ctx, "@root/path")?
+        .as_json()
+        .as_str()
+        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
+        .replace("\"", "");
+
+    context.insert(
+        "path_to_root".to_owned(),
+        json!(utils::fs::path_to_root(&base_path)),
+    );
+
+    chapter
+        .get("name")
+        .ok_or_else(|| RenderError::new("No title found for chapter in JSON data"))
+        .map(|name| context.insert("title".to_owned(), json!(name)))?;
+
+    chapter
+        .get("path")
+        .ok_or_else(|| RenderError::new("No path found for chapter in JSON data"))
+        .and_then(|p| {
+            Path::new(p)
+                .with_extension("html")
+                .to_str()
+                .ok_or_else(|| RenderError::new("Link could not be converted to str"))
+                .map(|p| context.insert("link".to_owned(), json!(p.replace("\\", "/"))))
+        })?;
+
+    trace!("Render template");
+
+    _h.template()
+        .ok_or_else(|| RenderError::new("Error with the handlebars template"))
+        .and_then(|t| {
+            let mut local_rc = rc.clone();
+            let local_ctx = Context::wraps(&context)?;
+            t.render(r, &local_ctx, &mut local_rc, out)
+        })?;
+
     Ok(())
 }
+
+pub fn previous(
+    _h: &Helper<'_, '_>,
+    r: &Handlebars<'_>,
+    ctx: &Context,
+    rc: &mut RenderContext<'_, '_>,
+    out: &mut dyn Output,
+) -> Result<(), RenderError> {
+    trace!("previous (handlebars helper)");
+
+    if let Some(previous) = find_chapter(ctx, rc, Target::Previous)? {
+        render(_h, r, ctx, rc, out, &previous)?;
+    }
+
+    Ok(())
+}
+
+pub fn next(
+    _h: &Helper<'_, '_>,
+    r: &Handlebars<'_>,
+    ctx: &Context,
+    rc: &mut RenderContext<'_, '_>,
+    out: &mut dyn Output,
+) -> Result<(), RenderError> {
+    trace!("next (handlebars helper)");
+
+    if let Some(next) = find_chapter(ctx, rc, Target::Next)? {
+        render(_h, r, ctx, rc, out, &next)?;
+    }
+
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    static TEMPLATE: &str =
+        "{{#previous}}{{title}}: {{link}}{{/previous}}|{{#next}}{{title}}: {{link}}{{/next}}";
+
+    #[test]
+    fn test_next_previous() {
+        let data = json!({
+           "name": "two",
+           "path": "two.path",
+           "chapters": [
+              {
+                 "name": "one",
+                 "path": "one.path"
+              },
+              {
+                 "name": "two",
+                 "path": "two.path",
+              },
+              {
+                 "name": "three",
+                 "path": "three.path"
+              }
+           ]
+        });
+
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
+
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "one: one.html|three: three.html"
+        );
+    }
+
+    #[test]
+    fn test_first() {
+        let data = json!({
+           "name": "one",
+           "path": "one.path",
+           "chapters": [
+              {
+                 "name": "one",
+                 "path": "one.path"
+              },
+              {
+                 "name": "two",
+                 "path": "two.path",
+              },
+              {
+                 "name": "three",
+                 "path": "three.path"
+              }
+           ]
+        });
+
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
+
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "|two: two.html"
+        );
+    }
+    #[test]
+    fn test_last() {
+        let data = json!({
+           "name": "three",
+           "path": "three.path",
+           "chapters": [
+              {
+                 "name": "one",
+                 "path": "one.path"
+              },
+              {
+                 "name": "two",
+                 "path": "two.path",
+              },
+              {
+                 "name": "three",
+                 "path": "three.path"
+              }
+           ]
+        });
+
+        let mut h = Handlebars::new();
+        h.register_helper("previous", Box::new(previous));
+        h.register_helper("next", Box::new(next));
+
+        assert_eq!(
+            h.render_template(TEMPLATE, &data).unwrap(),
+            "two: two.html|"
+        );
+    }
+}

src/renderer/html_handlebars/helpers/playpen.rs

@@ -1,195 +0,0 @@
-use std::path::{Path, PathBuf};
-use std::fs::File;
-use std::io::Read;
-
-
-pub fn render_playpen(s: &str, path: &Path) -> String {
-    // When replacing one thing in a string by something with a different length, the indices
-    // after that will not correspond, we therefore have to store the difference to correct this
-    let mut previous_end_index = 0;
-    let mut replaced = String::new();
-
-    for playpen in find_playpens(s, path) {
-
-        if playpen.escaped {
-            replaced.push_str(&s[previous_end_index..playpen.start_index - 1]);
-            replaced.push_str(&s[playpen.start_index..playpen.end_index]);
-            previous_end_index = playpen.end_index;
-            continue;
-        }
-
-        // Check if the file exists
-        if !playpen.rust_file.exists() || !playpen.rust_file.is_file() {
-            warn!("[-] No file exists for {{{{#playpen }}}}\n    {}", playpen.rust_file.to_str().unwrap());
-            continue;
-        }
-
-        // Open file & read file
-        let mut file = if let Ok(f) = File::open(&playpen.rust_file) {
-            f
-        } else {
-            continue;
-        };
-        let mut file_content = String::new();
-        if file.read_to_string(&mut file_content).is_err() {
-            continue;
-        };
-
-        let replacement = String::new() + "<pre><code class=\"language-rust\">" + &file_content +
-                          "</code></pre>";
-
-        replaced.push_str(&s[previous_end_index..playpen.start_index]);
-        replaced.push_str(&replacement);
-        previous_end_index = playpen.end_index;
-        // println!("Playpen{{ {}, {}, {:?}, {} }}", playpen.start_index, playpen.end_index, playpen.rust_file,
-        // playpen.editable);
-    }
-
-    replaced.push_str(&s[previous_end_index..]);
-
-    replaced
-}
-
-#[derive(PartialOrd, PartialEq, Debug)]
-struct Playpen {
-    start_index: usize,
-    end_index: usize,
-    rust_file: PathBuf,
-    editable: bool,
-    escaped: bool,
-}
-
-fn find_playpens(s: &str, base_path: &Path) -> Vec<Playpen> {
-    let mut playpens = vec![];
-    for (i, _) in s.match_indices("{{#playpen") {
-        debug!("[*]: find_playpen");
-
-        let mut escaped = false;
-
-        if i > 0 {
-            if let Some(c) = s[i - 1..].chars().nth(0) {
-                if c == '\\' {
-                    escaped = true
-                }
-            }
-        }
-        // DON'T forget the "+ i" else you have an index out of bounds error !!
-        let end_i = if let Some(n) = s[i..].find("}}") {
-            n
-        } else {
-            continue;
-        } + i + 2;
-
-        debug!("s[{}..{}] = {}", i, end_i, s[i..end_i].to_string());
-
-        // If there is nothing between "{{#playpen" and "}}" skip
-        if end_i - 2 - (i + 10) < 1 {
-            continue;
-        }
-        if s[i + 10..end_i - 2].trim().is_empty() {
-            continue;
-        }
-
-        debug!("{}", s[i + 10..end_i - 2].to_string());
-
-        // Split on whitespaces
-        let params: Vec<&str> = s[i + 10..end_i - 2].split_whitespace().collect();
-        let editable = params
-            .get(1)
-            .map(|p| p.find("editable").is_some())
-            .unwrap_or(false);
-
-        playpens.push(Playpen {
-            start_index: i,
-            end_index: end_i,
-            rust_file: base_path.join(PathBuf::from(params[0])),
-            editable: editable,
-            escaped: escaped,
-        })
-    }
-
-    playpens
-}
-
-
-
-
-// ---------------------------------------------------------------------------------
-//      Tests
-//
-
-#[test]
-fn test_find_playpens_no_playpen() {
-    let s = "Some random text without playpen...";
-    assert!(find_playpens(s, Path::new("")) == vec![]);
-}
-
-#[test]
-fn test_find_playpens_partial_playpen() {
-    let s = "Some random text with {{#playpen...";
-    assert!(find_playpens(s, Path::new("")) == vec![]);
-}
-
-#[test]
-fn test_find_playpens_empty_playpen() {
-    let s = "Some random text with {{#playpen}} and {{#playpen   }}...";
-    assert!(find_playpens(s, Path::new("")) == vec![]);
-}
-
-#[test]
-fn test_find_playpens_simple_playpen() {
-    let s = "Some random text with {{#playpen file.rs}} and {{#playpen test.rs }}...";
-
-    println!("\nOUTPUT: {:?}\n", find_playpens(s, Path::new("")));
-
-    assert!(find_playpens(s, Path::new("")) ==
-            vec![Playpen {
-                     start_index: 22,
-                     end_index: 42,
-                     rust_file: PathBuf::from("file.rs"),
-                     editable: false,
-                     escaped: false,
-                 },
-                 Playpen {
-                     start_index: 47,
-                     end_index: 68,
-                     rust_file: PathBuf::from("test.rs"),
-                     editable: false,
-                     escaped: false,
-                 }]);
-}
-
-#[test]
-fn test_find_playpens_complex_playpen() {
-    let s = "Some random text with {{#playpen file.rs editable}} and {{#playpen test.rs editable }}...";
-
-    println!("\nOUTPUT: {:?}\n", find_playpens(s, Path::new("dir")));
-
-    assert!(find_playpens(s, Path::new("dir")) ==
-            vec![Playpen {
-                     start_index: 22,
-                     end_index: 51,
-                     rust_file: PathBuf::from("dir/file.rs"),
-                     editable: true,
-                     escaped: false,
-                 },
-                 Playpen {
-                     start_index: 56,
-                     end_index: 86,
-                     rust_file: PathBuf::from("dir/test.rs"),
-                     editable: true,
-                     escaped: false,
-                 }]);
-}
-
-#[test]
-fn test_find_playpens_escaped_playpen() {
-    let s = "Some random text with escaped playpen \\{{#playpen file.rs editable}} ...";
-
-    println!("\nOUTPUT: {:?}\n", find_playpens(s, Path::new("")));
-
-    assert!(find_playpens(s, Path::new("")) ==
-            vec![
-        Playpen{start_index: 39, end_index: 68, rust_file: PathBuf::from("file.rs"), editable: true, escaped: true},
-    ]);
-}

src/renderer/html_handlebars/helpers/theme.rs

@@ -0,0 +1,28 @@
+use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError};
+
+pub fn theme_option(
+    h: &Helper<'_, '_>,
+    _r: &Handlebars<'_>,
+    ctx: &Context,
+    rc: &mut RenderContext<'_, '_>,
+    out: &mut dyn Output,
+) -> Result<(), RenderError> {
+    trace!("theme_option (handlebars helper)");
+
+    let param = h.param(0).and_then(|v| v.value().as_str()).ok_or_else(|| {
+        RenderError::new("Param 0 with String type is required for theme_option helper.")
+    })?;
+
+    let default_theme = rc.evaluate(ctx, "@root/default_theme")?;
+    let default_theme_name = default_theme
+        .as_json()
+        .as_str()
+        .ok_or_else(|| RenderError::new("Type error for `default_theme`, string expected"))?;
+
+    out.write(param)?;
+    if param.to_lowercase() == default_theme_name.to_lowercase() {
+        out.write(" (default)")?;
+    }
+
+    Ok(())
+}

src/renderer/html_handlebars/helpers/toc.rs

@@ -1,114 +1,158 @@
+use std::collections::BTreeMap;
 use std::path::Path;
-use std::collections::{VecDeque, BTreeMap};
 
-use serde_json;
-use handlebars::{Handlebars, HelperDef, RenderError, RenderContext, Helper};
-use pulldown_cmark::{Parser, html, Event, Tag};
+use crate::utils;
+
+use handlebars::{Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError};
+use pulldown_cmark::{html, Event, Parser};
 
 // Handlebars helper to construct TOC
 #[derive(Clone, Copy)]
-pub struct RenderToc;
+pub struct RenderToc {
+    pub no_section_label: bool,
+}
 
 impl HelperDef for RenderToc {
-    fn call(&self, _h: &Helper, _: &Handlebars, rc: &mut RenderContext) -> Result<(), RenderError> {
-
+    fn call<'reg: 'rc, 'rc>(
+        &self,
+        _h: &Helper<'reg, 'rc>,
+        _r: &'reg Handlebars<'_>,
+        ctx: &'rc Context,
+        rc: &mut RenderContext<'reg, 'rc>,
+        out: &mut dyn Output,
+    ) -> Result<(), RenderError> {
         // get value from context data
         // rc.get_path() is current json parent path, you should always use it like this
         // param is the key of value you want to display
-        let chapters = rc.context().navigate(rc.get_path(), &VecDeque::new(), "chapters").to_owned();
-        let current = rc.context().navigate(rc.get_path(), &VecDeque::new(), "path").to_string().replace("\"", "");
-        try!(rc.writer.write_all("<ul class=\"chapter\">".as_bytes()));
+        let chapters = rc.evaluate(ctx, "@root/chapters").and_then(|c| {
+            serde_json::value::from_value::<Vec<BTreeMap<String, String>>>(c.as_json().clone())
+                .map_err(|_| RenderError::new("Could not decode the JSON data"))
+        })?;
+        let current_path = rc
+            .evaluate(ctx, "@root/path")?
+            .as_json()
+            .as_str()
+            .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
+            .replace("\"", "");
 
-        // Decode json format
-        let decoded: Vec<BTreeMap<String, String>> = serde_json::from_str(&chapters.to_string()).unwrap();
+        let current_section = rc
+            .evaluate(ctx, "@root/section")?
+            .as_json()
+            .as_str()
+            .map(str::to_owned)
+            .unwrap_or_default();
+
+        let fold_enable = rc
+            .evaluate(ctx, "@root/fold_enable")?
+            .as_json()
+            .as_bool()
+            .ok_or_else(|| RenderError::new("Type error for `fold_enable`, bool expected"))?;
+
+        let fold_level = rc
+            .evaluate(ctx, "@root/fold_level")?
+            .as_json()
+            .as_u64()
+            .ok_or_else(|| RenderError::new("Type error for `fold_level`, u64 expected"))?;
+
+        out.write("<ol class=\"chapter\">")?;
 
         let mut current_level = 1;
 
-        for item in decoded {
-
+        for item in chapters {
             // Spacer
             if item.get("spacer").is_some() {
-                try!(rc.writer.write_all("<li class=\"spacer\"></li>".as_bytes()));
+                out.write("<li class=\"spacer\"></li>")?;
                 continue;
             }
 
-            let level = if let Some(s) = item.get("section") {
-                s.matches(".").count()
+            let (section, level) = if let Some(s) = item.get("section") {
+                (s.as_str(), s.matches('.').count())
             } else {
-                1
+                ("", 1)
             };
 
+            let is_expanded =
+                if !fold_enable || (!section.is_empty() && current_section.starts_with(section)) {
+                    // Expand if folding is disabled, or if the section is an
+                    // ancestor or the current section itself.
+                    true
+                } else {
+                    // Levels that are larger than this would be folded.
+                    level - 1 < fold_level as usize
+                };
+
             if level > current_level {
                 while level > current_level {
-                    try!(rc.writer.write_all("<li>".as_bytes()));
-                    try!(rc.writer.write_all("<ul class=\"section\">".as_bytes()));
+                    out.write("<li>")?;
+                    out.write("<ol class=\"section\">")?;
                     current_level += 1;
                 }
-                try!(rc.writer.write_all("<li>".as_bytes()));
+                write_li_open_tag(out, is_expanded, false)?;
             } else if level < current_level {
                 while level < current_level {
-                    try!(rc.writer.write_all("</ul>".as_bytes()));
-                    try!(rc.writer.write_all("</li>".as_bytes()));
+                    out.write("</ol>")?;
+                    out.write("</li>")?;
                     current_level -= 1;
                 }
-                try!(rc.writer.write_all("<li>".as_bytes()));
+                write_li_open_tag(out, is_expanded, false)?;
             } else {
-                try!(rc.writer.write_all("<li".as_bytes()));
-                if item.get("section").is_none() {
-                    try!(rc.writer.write_all(" class=\"affix\"".as_bytes()));
-                }
-                try!(rc.writer.write_all(">".as_bytes()));
+                write_li_open_tag(out, is_expanded, item.get("section").is_none())?;
+            }
+
+            // Part title
+            if let Some(title) = item.get("part") {
+                out.write("<li class=\"part-title\">")?;
+                out.write(title)?;
+                out.write("</li>")?;
+                continue;
             }
 
             // Link
-            let path_exists = if let Some(path) = item.get("path") {
-                if !path.is_empty() {
-                    try!(rc.writer.write_all("<a href=\"".as_bytes()));
+            let path_exists = if let Some(path) =
+                item.get("path")
+                    .and_then(|p| if p.is_empty() { None } else { Some(p) })
+            {
+                out.write("<a href=\"")?;
 
-                    // Add link
-                    try!(rc.writer.write_all(Path::new(item.get("path")
-                                                       .expect("Error: path should be Some(_)"))
-                                             .with_extension("html")
-                                             .to_str()
-                                             .unwrap()
-                                             // Hack for windows who tends to use `\` as separator instead of `/`
-                                             .replace("\\", "/")
-                                             .as_bytes()));
+                let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
+                    .with_extension("html")
+                    .to_str()
+                    .unwrap()
+                    // Hack for windows who tends to use `\` as separator instead of `/`
+                    .replace("\\", "/");
 
-                    try!(rc.writer.write_all("\"".as_bytes()));
+                // Add link
+                out.write(&utils::fs::path_to_root(&current_path))?;
+                out.write(&tmp)?;
+                out.write("\"")?;
 
-                    if path == &current {
-                        try!(rc.writer.write_all(" class=\"active\"".as_bytes()));
-                    }
-
-                    try!(rc.writer.write_all(">".as_bytes()));
-                    true
-                } else {
-                    false
+                if path == &current_path {
+                    out.write(" class=\"active\"")?;
                 }
+
+                out.write(">")?;
+                true
             } else {
+                out.write("<div>")?;
                 false
             };
 
-            // Section does not necessarily exist
-            if let Some(section) = item.get("section") {
-                try!(rc.writer.write_all("<strong>".as_bytes()));
-                try!(rc.writer.write_all(section.as_bytes()));
-                try!(rc.writer.write_all("</strong> ".as_bytes()));
+            if !self.no_section_label {
+                // Section does not necessarily exist
+                if let Some(section) = item.get("section") {
+                    out.write("<strong aria-hidden=\"true\">")?;
+                    out.write(&section)?;
+                    out.write("</strong> ")?;
+                }
             }
 
             if let Some(name) = item.get("name") {
                 // Render only inline code blocks
 
                 // filter all events that are not inline code blocks
-                let parser = Parser::new(name).filter(|event| {
-                    match *event {
-                        Event::Start(Tag::Code) |
-                        Event::End(Tag::Code) |
-                        Event::InlineHtml(_) |
-                        Event::Text(_) => true,
-                        _ => false,
-                    }
+                let parser = Parser::new(name).filter(|event| match *event {
+                    Event::Code(_) | Event::Html(_) | Event::Text(_) => true,
+                    _ => false,
                 });
 
                 // render markdown to html
@@ -116,23 +160,47 @@ impl HelperDef for RenderToc {
                 html::push_html(&mut markdown_parsed_name, parser);
 
                 // write to the handlebars template
-                try!(rc.writer.write_all(markdown_parsed_name.as_bytes()));
+                out.write(&markdown_parsed_name)?;
             }
 
             if path_exists {
-                try!(rc.writer.write_all("</a>".as_bytes()));
+                out.write("</a>")?;
+            } else {
+                out.write("</div>")?;
             }
 
-            try!(rc.writer.write_all("</li>".as_bytes()));
-
+            // Render expand/collapse toggle
+            if let Some(flag) = item.get("has_sub_items") {
+                let has_sub_items = flag.parse::<bool>().unwrap_or_default();
+                if fold_enable && has_sub_items {
+                    out.write("<a class=\"toggle\"><div>❱</div></a>")?;
+                }
+            }
+            out.write("</li>")?;
         }
         while current_level > 1 {
-            try!(rc.writer.write_all("</ul>".as_bytes()));
-            try!(rc.writer.write_all("</li>".as_bytes()));
+            out.write("</ol>")?;
+            out.write("</li>")?;
             current_level -= 1;
         }
 
-        try!(rc.writer.write_all("</ul>".as_bytes()));
+        out.write("</ol>")?;
         Ok(())
     }
 }
+
+fn write_li_open_tag(
+    out: &mut dyn Output,
+    is_expanded: bool,
+    is_affix: bool,
+) -> Result<(), std::io::Error> {
+    let mut li = String::from("<li class=\"chapter-item ");
+    if is_expanded {
+        li.push_str("expanded ");
+    }
+    if is_affix {
+        li.push_str("affix ");
+    }
+    li.push_str("\">");
+    out.write(&li)
+}

src/renderer/html_handlebars/mod.rs

@@ -1,4 +1,9 @@
+#![allow(missing_docs)] // FIXME: Document this
+
 pub use self::hbs_renderer::HtmlHandlebars;
 
 mod hbs_renderer;
 mod helpers;
+
+#[cfg(feature = "search")]
+mod search;

src/renderer/html_handlebars/search.rs

@@ -0,0 +1,259 @@
+use std::borrow::Cow;
+use std::collections::{HashMap, HashSet};
+use std::path::Path;
+
+use elasticlunr::Index;
+use pulldown_cmark::*;
+
+use crate::book::{Book, BookItem};
+use crate::config::Search;
+use crate::errors::*;
+use crate::theme::searcher;
+use crate::utils;
+
+/// Creates all files required for search.
+pub fn create_files(search_config: &Search, destination: &Path, book: &Book) -> Result<()> {
+    let mut index = Index::new(&["title", "body", "breadcrumbs"]);
+    let mut doc_urls = Vec::with_capacity(book.sections.len());
+
+    for item in book.iter() {
+        render_item(&mut index, &search_config, &mut doc_urls, item)?;
+    }
+
+    let index = write_to_json(index, &search_config, doc_urls)?;
+    debug!("Writing search index ✓");
+    if index.len() > 10_000_000 {
+        warn!("searchindex.json is very large ({} bytes)", index.len());
+    }
+
+    if search_config.copy_js {
+        utils::fs::write_file(destination, "searchindex.json", index.as_bytes())?;
+        utils::fs::write_file(
+            destination,
+            "searchindex.js",
+            format!("Object.assign(window.search, {});", index).as_bytes(),
+        )?;
+        utils::fs::write_file(destination, "searcher.js", searcher::JS)?;
+        utils::fs::write_file(destination, "mark.min.js", searcher::MARK_JS)?;
+        utils::fs::write_file(destination, "elasticlunr.min.js", searcher::ELASTICLUNR_JS)?;
+        debug!("Copying search files ✓");
+    }
+
+    Ok(())
+}
+
+/// Uses the given arguments to construct a search document, then inserts it to the given index.
+fn add_doc(
+    index: &mut Index,
+    doc_urls: &mut Vec<String>,
+    anchor_base: &str,
+    section_id: &Option<String>,
+    items: &[&str],
+) {
+    let url = if let Some(ref id) = *section_id {
+        Cow::Owned(format!("{}#{}", anchor_base, id))
+    } else {
+        Cow::Borrowed(anchor_base)
+    };
+    let url = utils::collapse_whitespace(url.trim());
+    let doc_ref = doc_urls.len().to_string();
+    doc_urls.push(url.into());
+
+    let items = items.iter().map(|&x| utils::collapse_whitespace(x.trim()));
+    index.add_doc(&doc_ref, items);
+}
+
+/// Renders markdown into flat unformatted text and adds it to the search index.
+fn render_item(
+    index: &mut Index,
+    search_config: &Search,
+    doc_urls: &mut Vec<String>,
+    item: &BookItem,
+) -> Result<()> {
+    let chapter = match *item {
+        BookItem::Chapter(ref ch) if !ch.is_draft_chapter() => ch,
+        _ => return Ok(()),
+    };
+
+    let chapter_path = chapter
+        .path
+        .as_ref()
+        .expect("Checked that path exists above");
+    let filepath = Path::new(&chapter_path).with_extension("html");
+    let filepath = filepath
+        .to_str()
+        .with_context(|| "Could not convert HTML path to str")?;
+    let anchor_base = utils::fs::normalize_path(filepath);
+
+    let mut p = utils::new_cmark_parser(&chapter.content).peekable();
+
+    let mut in_heading = false;
+    let max_section_depth = u32::from(search_config.heading_split_level);
+    let mut section_id = None;
+    let mut heading = String::new();
+    let mut body = String::new();
+    let mut breadcrumbs = chapter.parent_names.clone();
+    let mut footnote_numbers = HashMap::new();
+
+    while let Some(event) = p.next() {
+        match event {
+            Event::Start(Tag::Heading(i)) if i <= max_section_depth => {
+                if !heading.is_empty() {
+                    // Section finished, the next heading is following now
+                    // Write the data to the index, and clear it for the next section
+                    add_doc(
+                        index,
+                        doc_urls,
+                        &anchor_base,
+                        &section_id,
+                        &[&heading, &body, &breadcrumbs.join(" » ")],
+                    );
+                    section_id = None;
+                    heading.clear();
+                    body.clear();
+                    breadcrumbs.pop();
+                }
+
+                in_heading = true;
+            }
+            Event::End(Tag::Heading(i)) if i <= max_section_depth => {
+                in_heading = false;
+                section_id = Some(utils::id_from_content(&heading));
+                breadcrumbs.push(heading.clone());
+            }
+            Event::Start(Tag::FootnoteDefinition(name)) => {
+                let number = footnote_numbers.len() + 1;
+                footnote_numbers.entry(name).or_insert(number);
+            }
+            Event::Html(html) => {
+                let mut html_block = html.into_string();
+
+                // As of pulldown_cmark 0.6, html events are no longer contained
+                // in an HtmlBlock tag. We must collect consecutive Html events
+                // into a block ourselves.
+                while let Some(Event::Html(html)) = p.peek() {
+                    html_block.push_str(&html);
+                    p.next();
+                }
+
+                body.push_str(&clean_html(&html_block));
+            }
+            Event::Start(_) | Event::End(_) | Event::Rule | Event::SoftBreak | Event::HardBreak => {
+                // Insert spaces where HTML output would usually seperate text
+                // to ensure words don't get merged together
+                if in_heading {
+                    heading.push(' ');
+                } else {
+                    body.push(' ');
+                }
+            }
+            Event::Text(text) | Event::Code(text) => {
+                if in_heading {
+                    heading.push_str(&text);
+                } else {
+                    body.push_str(&text);
+                }
+            }
+            Event::FootnoteReference(name) => {
+                let len = footnote_numbers.len() + 1;
+                let number = footnote_numbers.entry(name).or_insert(len);
+                body.push_str(&format!(" [{}] ", number));
+            }
+            Event::TaskListMarker(_checked) => {}
+        }
+    }
+
+    if !heading.is_empty() {
+        // Make sure the last section is added to the index
+        add_doc(
+            index,
+            doc_urls,
+            &anchor_base,
+            &section_id,
+            &[&heading, &body, &breadcrumbs.join(" » ")],
+        );
+    }
+
+    Ok(())
+}
+
+fn write_to_json(index: Index, search_config: &Search, doc_urls: Vec<String>) -> Result<String> {
+    use elasticlunr::config::{SearchBool, SearchOptions, SearchOptionsField};
+    use std::collections::BTreeMap;
+
+    #[derive(Serialize)]
+    struct ResultsOptions {
+        limit_results: u32,
+        teaser_word_count: u32,
+    }
+
+    #[derive(Serialize)]
+    struct SearchindexJson {
+        /// The options used for displaying search results
+        results_options: ResultsOptions,
+        /// The searchoptions for elasticlunr.js
+        search_options: SearchOptions,
+        /// Used to lookup a document's URL from an integer document ref.
+        doc_urls: Vec<String>,
+        /// The index for elasticlunr.js
+        index: elasticlunr::Index,
+    }
+
+    let mut fields = BTreeMap::new();
+    let mut opt = SearchOptionsField::default();
+    opt.boost = Some(search_config.boost_title);
+    fields.insert("title".into(), opt);
+    opt.boost = Some(search_config.boost_paragraph);
+    fields.insert("body".into(), opt);
+    opt.boost = Some(search_config.boost_hierarchy);
+    fields.insert("breadcrumbs".into(), opt);
+
+    let search_options = SearchOptions {
+        bool: if search_config.use_boolean_and {
+            SearchBool::And
+        } else {
+            SearchBool::Or
+        },
+        expand: search_config.expand,
+        fields,
+    };
+
+    let results_options = ResultsOptions {
+        limit_results: search_config.limit_results,
+        teaser_word_count: search_config.teaser_word_count,
+    };
+
+    let json_contents = SearchindexJson {
+        results_options,
+        search_options,
+        doc_urls,
+        index,
+    };
+
+    // By converting to serde_json::Value as an intermediary, we use a
+    // BTreeMap internally and can force a stable ordering of map keys.
+    let json_contents = serde_json::to_value(&json_contents)?;
+    let json_contents = serde_json::to_string(&json_contents)?;
+
+    Ok(json_contents)
+}
+
+fn clean_html(html: &str) -> String {
+    lazy_static! {
+        static ref AMMONIA: ammonia::Builder<'static> = {
+            let mut clean_content = HashSet::new();
+            clean_content.insert("script");
+            clean_content.insert("style");
+            let mut builder = ammonia::Builder::new();
+            builder
+                .tags(HashSet::new())
+                .tag_attributes(HashMap::new())
+                .generic_attributes(HashSet::new())
+                .link_rel(None)
+                .allowed_classes(HashMap::new())
+                .clean_content_tags(clean_content);
+            builder
+        };
+    }
+    AMMONIA.clean(html).to_string()
+}

src/renderer/markdown_renderer.rs

@@ -0,0 +1,52 @@
+use crate::book::BookItem;
+use crate::errors::*;
+use crate::renderer::{RenderContext, Renderer};
+use crate::utils;
+
+use std::fs;
+
+#[derive(Default)]
+/// A renderer to output the Markdown after the preprocessors have run. Mostly useful
+/// when debugging preprocessors.
+pub struct MarkdownRenderer;
+
+impl MarkdownRenderer {
+    /// Create a new `MarkdownRenderer` instance.
+    pub fn new() -> Self {
+        MarkdownRenderer
+    }
+}
+
+impl Renderer for MarkdownRenderer {
+    fn name(&self) -> &str {
+        "markdown"
+    }
+
+    fn render(&self, ctx: &RenderContext) -> Result<()> {
+        let destination = &ctx.destination;
+        let book = &ctx.book;
+
+        if destination.exists() {
+            utils::fs::remove_dir_content(destination)
+                .with_context(|| "Unable to remove stale Markdown output")?;
+        }
+
+        trace!("markdown render");
+        for item in book.iter() {
+            if let BookItem::Chapter(ref ch) = *item {
+                if !ch.is_draft_chapter() {
+                    utils::fs::write_file(
+                        &ctx.destination,
+                        &ch.path.as_ref().expect("Checked path exists before"),
+                        ch.content.as_bytes(),
+                    )?;
+                }
+            }
+        }
+
+        fs::create_dir_all(&destination)
+            .with_context(|| "Unexpected error when constructing destination path")?;
+
+        Ok(())
+    }
+}