]>
Commit | Line | Data |
---|---|---|
dc9dc135 XL |
1 | # Changelog |
2 | ||
f25598a0 FG |
3 | ## mdBook 0.4.25 |
4 | [e14d381...1ba74a3](https://github.com/rust-lang/mdBook/compare/e14d381...1ba74a3) | |
5 | ||
6 | ### Fixed | |
7 | - Fixed a regression where `mdbook test -L deps path-to-book` would not work. | |
8 | [#1959](https://github.com/rust-lang/mdBook/pull/1959) | |
9 | ||
10 | ## mdBook 0.4.24 | |
11 | [eb77083...8767ebf](https://github.com/rust-lang/mdBook/compare/eb77083...8767ebf) | |
12 | ||
13 | ### Fixed | |
14 | - The precompiled linux-gnu mdbook binary available on [GitHub Releases](https://github.com/rust-lang/mdBook/releases) inadvertently switched to a newer version of glibc. This release goes back to an older version that should be more compatible on older versions of Linux. | |
15 | [#1955](https://github.com/rust-lang/mdBook/pull/1955) | |
16 | ||
17 | ## mdBook 0.4.23 | |
18 | [678b469...68a75da](https://github.com/rust-lang/mdBook/compare/678b469...68a75da) | |
19 | ||
20 | ### Changed | |
21 | - Updated all dependencies | |
22 | [#1951](https://github.com/rust-lang/mdBook/pull/1951) | |
23 | [#1952](https://github.com/rust-lang/mdBook/pull/1952) | |
24 | [#1844](https://github.com/rust-lang/mdBook/pull/1844) | |
25 | - Updated minimum Rust version to 1.60. | |
26 | [#1951](https://github.com/rust-lang/mdBook/pull/1951) | |
27 | ||
28 | ### Fixed | |
29 | - Fixed a regression where playground code was missing hidden lines, preventing it from compiling correctly. | |
30 | [#1950](https://github.com/rust-lang/mdBook/pull/1950) | |
31 | ||
32 | ## mdBook 0.4.22 | |
33 | [40c06f5...4844f72](https://github.com/rust-lang/mdBook/compare/40c06f5...4844f72) | |
34 | ||
35 | ### Added | |
36 | - Added a `--chapter` option to `mdbook test` to specify a specific chapter to test. | |
37 | [#1741](https://github.com/rust-lang/mdBook/pull/1741) | |
38 | - Added CSS styling for `<kbd>` tags. | |
39 | [#1906](https://github.com/rust-lang/mdBook/pull/1906) | |
40 | - Added pre-compiled binaries for `x86_64-unknown-linux-musl` and `aarch64-unknown-linux-musl` (see [Releases](https://github.com/rust-lang/mdBook/releases)). | |
41 | [#1862](https://github.com/rust-lang/mdBook/pull/1862) | |
42 | - Added `build.extra-watch-dirs` which is an array of additional directories to watch for changes when running `mdbook serve`. | |
43 | [#1884](https://github.com/rust-lang/mdBook/pull/1884) | |
44 | ||
45 | ### Changed | |
46 | - Removed the `type="text/javascript"` attribute from `<script>` tags. | |
47 | [#1881](https://github.com/rust-lang/mdBook/pull/1881) | |
48 | - Switched to building with Rust Edition 2021. | |
49 | This raises the minimum supported Rust version to 1.56. | |
50 | [#1887](https://github.com/rust-lang/mdBook/pull/1887) | |
51 | - When hidden code is hidden, the hidden parts are no longer copied to the clipboard via the copy button. | |
52 | [#1911](https://github.com/rust-lang/mdBook/pull/1911) | |
53 | - Various HTML changes and fixes to be more compliant with HTML5. | |
54 | [#1924](https://github.com/rust-lang/mdBook/pull/1924) | |
55 | - The theme picker now shows which theme is currently selected. | |
56 | [#1935](https://github.com/rust-lang/mdBook/pull/1935) | |
57 | ||
58 | ### Fixed | |
59 | - Avoid blank line at the end of an ACE code block | |
60 | [#1836](https://github.com/rust-lang/mdBook/pull/1836) | |
61 | ||
62 | ||
064997fb FG |
63 | ## mdBook 0.4.21 |
64 | [92afe9b...8f01d02](https://github.com/rust-lang/mdBook/compare/92afe9b...8f01d02) | |
65 | ||
66 | ### Fixed | |
67 | - Fixed an issue where mdBook would fail to compile with Rust nightly-2022-07-22. | |
68 | [#1861](https://github.com/rust-lang/mdBook/pull/1861) | |
69 | ||
70 | ## mdBook 0.4.20 | |
71 | [53055e0...da166e0](https://github.com/rust-lang/mdBook/compare/53055e0...da166e0) | |
72 | ||
73 | ### Fixed | |
74 | - Fixed a regression in 0.4.19 where inline code would have excessive padding | |
75 | in some situations such as headings. | |
76 | [#1855](https://github.com/rust-lang/mdBook/pull/1855) | |
77 | ||
78 | ## mdBook 0.4.19 | |
79 | [ae275ad...53055e0](https://github.com/rust-lang/mdBook/compare/ae275ad...53055e0) | |
80 | ||
81 | ### Added | |
82 | - The `serve` command now supports HEAD requests. | |
83 | [#1825](https://github.com/rust-lang/mdBook/pull/1825) | |
84 | ||
85 | ### Changed | |
86 | - An error is now generated when a custom theme directory does not exist. | |
87 | [#1791](https://github.com/rust-lang/mdBook/pull/1791) | |
88 | - Very wide tables now have independent horizontal scrolling so that scrolling | |
89 | to see the rest of the table will not scroll the entire page. | |
90 | [#1617](https://github.com/rust-lang/mdBook/pull/1617) | |
91 | - The buttons on code blocks are now only shown when the mouse cursor hovers | |
92 | over them (or tapped on mobile). There is also some extra spacing to reduce | |
93 | the overlap with the code. | |
94 | [#1806](https://github.com/rust-lang/mdBook/pull/1806) | |
95 | - The first chapter always generates an `index.html` file. Previously it would | |
96 | only generate the index file for prefix chapters. | |
97 | [#1829](https://github.com/rust-lang/mdBook/pull/1829) | |
98 | ||
99 | ### Fixed | |
100 | - `mdbook serve --open` now properly handles the case if the first chapter is a draft. | |
101 | [#1714](https://github.com/rust-lang/mdBook/pull/1714) | |
102 | [#1830](https://github.com/rust-lang/mdBook/pull/1830) | |
103 | - Very long words (over 80 characters) are no longer indexed to avoid a stack overflow. | |
104 | [#1833](https://github.com/rust-lang/mdBook/pull/1833) | |
105 | ||
04454e1e FG |
106 | ## mdBook 0.4.18 |
107 | [981b79b...ae275ad](https://github.com/rust-lang/mdBook/compare/981b79b...ae275ad) | |
108 | ||
109 | ### Fixed | |
110 | - Fixed rendering of SUMMARY links that contain markdown escapes or other | |
111 | markdown elements. | |
112 | [#1785](https://github.com/rust-lang/mdBook/pull/1785) | |
113 | ||
114 | ## mdBook 0.4.17 | |
115 | [a5fddfa...981b79b](https://github.com/rust-lang/mdBook/compare/a5fddfa...981b79b) | |
116 | ||
117 | ### Fixed | |
118 | - Fixed parsing of `output.html.print` configuration table. | |
119 | [#1775](https://github.com/rust-lang/mdBook/pull/1775) | |
120 | ||
121 | ## mdBook 0.4.16 | |
122 | [68a5c09...a5fddfa](https://github.com/rust-lang/mdBook/compare/68a5c09...a5fddfa) | |
123 | ||
124 | ### Added | |
125 | - Added `output.html.print.page-break` config option to control whether or not | |
126 | there is a page break between chapters in the print output. | |
127 | [#1728](https://github.com/rust-lang/mdBook/pull/1728) | |
128 | - Added `output.html.playground.runnable` config option to globally disable | |
129 | the run button in code blocks. | |
130 | [#1546](https://github.com/rust-lang/mdBook/pull/1546) | |
131 | ||
132 | ### Changed | |
064997fb | 133 | - The `mdbook serve` live reload websocket now uses the protocol, host, and |
04454e1e FG |
134 | port of the current page, allowing access through a proxy. |
135 | [#1771](https://github.com/rust-lang/mdBook/pull/1771) | |
136 | - The 404 not-found page now includes the books title in the HTML title tag. | |
137 | [#1693](https://github.com/rust-lang/mdBook/pull/1693) | |
138 | - Migrated to clap 3.0 which which handles CLI option parsing. | |
139 | [#1731](https://github.com/rust-lang/mdBook/pull/1731) | |
140 | ||
141 | ### Fixed | |
142 | - Minor fixes to the markdown parser. | |
143 | [#1729](https://github.com/rust-lang/mdBook/pull/1729) | |
144 | - Fixed incorrect parsing in `SUMMARY.md` when it didn't start with a title. | |
145 | [#1744](https://github.com/rust-lang/mdBook/pull/1744) | |
146 | - Fixed duplicate anchor IDs for links in search results. | |
147 | [#1749](https://github.com/rust-lang/mdBook/pull/1749) | |
148 | ||
a2a8927a XL |
149 | ## mdBook 0.4.15 |
150 | [5eb7d46...68a5c09](https://github.com/rust-lang/mdBook/compare/5eb7d46...68a5c09) | |
151 | ||
152 | ### Changed | |
153 | - Major update to expand the documentation located at <https://rust-lang.github.io/mdBook/>. | |
154 | [#1709](https://github.com/rust-lang/mdBook/pull/1709) | |
155 | [#1710](https://github.com/rust-lang/mdBook/pull/1710) | |
156 | - Updated the markdown parser with various fixes for common-mark compliance. | |
157 | [#1712](https://github.com/rust-lang/mdBook/pull/1712) | |
158 | ||
159 | ## mdBook 0.4.14 | |
160 | [ffa8284...c9b6be8](https://github.com/rust-lang/mdBook/compare/ffa8284...c9b6be8) | |
161 | ||
162 | ### Added | |
163 | - The 2021 Rust edition option has been stabilized. | |
164 | [#1642](https://github.com/rust-lang/mdBook/pull/1642) | |
165 | ||
166 | ### Changed | |
167 | - Header anchors no longer include any HTML tags. Previously only a small | |
168 | subset were excluded. | |
169 | [#1683](https://github.com/rust-lang/mdBook/pull/1683) | |
170 | - Deprecated the google-analytics option. Books using this option should place | |
171 | the appropriate code in the `theme/head.hbs` file instead. | |
172 | [#1675](https://github.com/rust-lang/mdBook/pull/1675) | |
173 | ||
174 | ### Fixed | |
175 | - Updated the markdown parser which brings in a few small fixes and removes | |
176 | the custom smart quote handling. | |
177 | [#1668](https://github.com/rust-lang/mdBook/pull/1668) | |
178 | - Fixed iOS Safari enlarging text when going into landscape mode. | |
179 | [#1685](https://github.com/rust-lang/mdBook/pull/1685) | |
180 | ||
181 | ## mdBook 0.4.13 | |
182 | [e6629cd...f55028b](https://github.com/rust-lang/mdBook/compare/e6629cd...f55028b) | |
183 | ||
184 | ### Added | |
185 | ||
186 | - Added the ability to specify the preprocessor order. | |
187 | [#1607](https://github.com/rust-lang/mdBook/pull/1607) | |
188 | ||
189 | ### Fixed | |
190 | ||
191 | - Include chapters with no headers in the search index | |
192 | [#1637](https://github.com/rust-lang/mdBook/pull/1637) | |
193 | - Switched to the `opener` crate for opening a web browser, which should fix | |
194 | some issues with blocking. | |
195 | [#1656](https://github.com/rust-lang/mdBook/pull/1656) | |
196 | - Fixed clicking the border of the theme switcher breaking the theme selection. | |
197 | [#1651](https://github.com/rust-lang/mdBook/pull/1651) | |
198 | ||
94222f64 XL |
199 | ## mdBook 0.4.12 |
200 | [14add9c...8b4e488](https://github.com/rust-lang/mdBook/compare/14add9c...8b4e488) | |
201 | ||
202 | ### Changed | |
203 | - Reverted the change to update to highlight.js 11, as it broke hidden code lines. | |
204 | [#1597](https://github.com/rust-lang/mdBook/pull/1621) | |
205 | ||
206 | ## mdBook 0.4.11 | |
207 | [e440094...2cf00d0](https://github.com/rust-lang/mdBook/compare/e440094...2cf00d0) | |
208 | ||
209 | ### Added | |
210 | - Added support for Rust 2021 edition. | |
211 | [#1596](https://github.com/rust-lang/mdBook/pull/1596) | |
212 | - Added `mdbook completions` subcommand which provides shell completions. | |
213 | [#1425](https://github.com/rust-lang/mdBook/pull/1425) | |
214 | - Added `--title` and `--ignore` flags to `mdbook init` to avoid the | |
215 | interactive input. | |
216 | [#1559](https://github.com/rust-lang/mdBook/pull/1559) | |
217 | ||
218 | ### Changed | |
219 | - If running a Rust example does not have any output, it now displays the text | |
220 | "No output" instead of not showing anything. | |
221 | [#1599](https://github.com/rust-lang/mdBook/pull/1599) | |
222 | - Code block language tags can now be separated by space or tab (along with | |
223 | commas) to match the behavior of other sites like GitHub and rustdoc. | |
224 | [#1469](https://github.com/rust-lang/mdBook/pull/1469) | |
225 | - Updated `warp` (the web server) to the latest version. | |
226 | This also updates the minimum supported Rust version to 1.46. | |
227 | [#1612](https://github.com/rust-lang/mdBook/pull/1612) | |
228 | - Updated to highlight.js 11. This has various highlighting improvements. | |
229 | [#1597](https://github.com/rust-lang/mdBook/pull/1597) | |
230 | ||
231 | ### Fixed | |
232 | - Inline code blocks inside a header are no longer highlighted when | |
233 | `output.html.playground.editable` is `true`. | |
234 | [#1613](https://github.com/rust-lang/mdBook/pull/1613) | |
235 | ||
236 | ## mdBook 0.4.10 | |
237 | [2f7293a...dc2062a](https://github.com/rust-lang/mdBook/compare/2f7293a...dc2062a) | |
238 | ||
239 | ### Changed | |
240 | - Reverted breaking change in 0.4.9 that removed the `__non_exhaustive` marker | |
241 | on the `Book` struct. | |
242 | [#1572](https://github.com/rust-lang/mdBook/pull/1572) | |
243 | - Updated handlebars to 4.0. | |
244 | [#1550](https://github.com/rust-lang/mdBook/pull/1550) | |
245 | - Removed the `chapter_begin` id on the print page's chapter separators. | |
246 | [#1541](https://github.com/rust-lang/mdBook/pull/1541) | |
247 | ||
248 | ## mdBook 0.4.9 | |
249 | [7e01cf9...d325c60](https://github.com/rust-lang/mdBook/compare/7e01cf9...d325c60) | |
250 | ||
251 | ### Changed | |
252 | - Updated all dependencies and raised the minimum Rust version to 1.42. | |
253 | [#1528](https://github.com/rust-lang/mdBook/pull/1528) | |
254 | - Added more detail to error message when a preprocessor fails. | |
255 | [#1526](https://github.com/rust-lang/mdBook/pull/1526) | |
256 | - Set max-width of HTML video tags to 100% to match img tags. | |
257 | [#1542](https://github.com/rust-lang/mdBook/pull/1542) | |
258 | ||
259 | ### Fixed | |
260 | - Type errors when parsing `book.toml` are no longer ignored. | |
261 | [#1539](https://github.com/rust-lang/mdBook/pull/1539) | |
262 | - Better handling if `mdbook serve` fails to start the http server. | |
263 | [#1555](https://github.com/rust-lang/mdBook/pull/1555) | |
264 | - Fixed the path for `edit-url-template` if the book used a source directory | |
265 | other than `src`. | |
266 | [#1554](https://github.com/rust-lang/mdBook/pull/1554) | |
267 | ||
268 | ## mdBook 0.4.8 | |
269 | [fcceee4...b592b10](https://github.com/rust-lang/mdBook/compare/fcceee4...b592b10) | |
270 | ||
271 | ### Added | |
272 | - Added the option `output.html.edit-url-template` which can be a URL which is | |
273 | linked on each page to direct the user to a site (such as GitHub) where the | |
274 | user can directly suggest an edit for the page they are currently reading. | |
275 | [#1506](https://github.com/rust-lang/mdBook/pull/1506) | |
276 | ||
277 | ### Changed | |
278 | - Printed output now includes a page break between chapters. | |
279 | [#1485](https://github.com/rust-lang/mdBook/pull/1485) | |
280 | ||
281 | ### Fixed | |
282 | - HTML, such as HTML comments, is now ignored if it appears above the title line | |
283 | in `SUMMARY.md`. | |
284 | [#1437](https://github.com/rust-lang/mdBook/pull/1437) | |
285 | ||
6a06907d XL |
286 | ## mdBook 0.4.7 |
287 | [9a9eb01...c83bbd6](https://github.com/rust-lang/mdBook/compare/9a9eb01...c83bbd6) | |
288 | ||
289 | ### Changed | |
290 | - Updated shlex parser to fix a minor parsing issue (used by the | |
291 | preprocessor/backend custom command config). | |
292 | [#1471](https://github.com/rust-lang/mdBook/pull/1471) | |
293 | - Enhanced text contrast of `light` theme to improve accessibility. | |
294 | [#1470](https://github.com/rust-lang/mdBook/pull/1470) | |
295 | ||
296 | ### Fixed | |
297 | - Fixed some issues with fragment scrolling and linking. | |
298 | [#1463](https://github.com/rust-lang/mdBook/pull/1463) | |
299 | ||
5869c6ff XL |
300 | ## mdBook 0.4.6 |
301 | [eaa6914...1a0c296](https://github.com/rust-lang/mdBook/compare/eaa6914...1a0c296) | |
302 | ||
303 | ### Changed | |
304 | - The chapter name is now included in the search breadcrumbs. | |
305 | [#1389](https://github.com/rust-lang/mdBook/pull/1389) | |
306 | - Pressing Escape will remove the `?highlight` argument from the URL. | |
307 | [#1427](https://github.com/rust-lang/mdBook/pull/1427) | |
308 | - `mdbook init --theme` will now place the theme in the root of the book | |
309 | directory instead of in the `src` directory. | |
310 | [#1432](https://github.com/rust-lang/mdBook/pull/1432) | |
311 | - A custom renderer that sets the `command` to a relative path now interprets | |
312 | the relative path relative to the book root. Previously it was inconsistent | |
313 | based on the platform (either relative to the current directory, or relative | |
314 | to the renderer output directory). Paths relative to the output directory | |
315 | are still supported with a deprecation warning. | |
316 | [#1418](https://github.com/rust-lang/mdBook/pull/1418) | |
317 | - The `theme` directory in the config is now interpreted as relative to the | |
318 | book root, instead of the current directory. | |
319 | [#1405](https://github.com/rust-lang/mdBook/pull/1405) | |
320 | - Handle UTF-8 BOM for chapter sources. | |
321 | [#1285](https://github.com/rust-lang/mdBook/pull/1285) | |
322 | - Removed extra whitespace added to `{{#playground}}` snippets. | |
323 | [#1375](https://github.com/rust-lang/mdBook/pull/1375) | |
324 | ||
325 | ### Fixed | |
326 | - Clicking on a search result with multiple search words will now correctly | |
327 | highlight all of the words. | |
328 | [#1426](https://github.com/rust-lang/mdBook/pull/1426) | |
329 | - Properly handle `<` and `>` characters in the table of contents. | |
330 | [#1376](https://github.com/rust-lang/mdBook/pull/1376) | |
331 | - Fixed to properly serialize the `build` table in the config, which prevented | |
332 | setting it in the API. | |
333 | [#1378](https://github.com/rust-lang/mdBook/pull/1378) | |
334 | ||
335 | ## mdBook 0.4.5 | |
336 | [eaa6914...f66df09](https://github.com/rust-lang/mdBook/compare/eaa6914...f66df09) | |
337 | ||
338 | ### Fixed | |
339 | ||
340 | - Fixed XSS in the search page. | |
341 | [CVE-2020-26297](https://groups.google.com/g/rustlang-security-announcements/c/3-sO6of29O0) | |
342 | [648c9ae](https://github.com/rust-lang/mdBook/commit/648c9ae772bec83f0a5954d17b4287d5bb1d6606) | |
343 | ||
fc512014 XL |
344 | ## mdBook 0.4.4 |
345 | [4df9ec9...01836ba](https://github.com/rust-lang/mdBook/compare/4df9ec9...01836ba) | |
346 | ||
347 | ### Added | |
348 | - Added the `output.html.print.enable` configuration value to disable the | |
349 | "print" page. | |
350 | [#1169](https://github.com/rust-lang/mdBook/pull/1169) | |
351 | - Added a list of supported languages for syntax-highlighting to the | |
352 | documentation. | |
353 | [#1345](https://github.com/rust-lang/mdBook/pull/1345) | |
354 | ||
355 | ### Fixed | |
356 | - Now supports symbolic links for files in the `src` directory. | |
357 | [#1323](https://github.com/rust-lang/mdBook/pull/1323) | |
358 | ||
1b1a35ee | 359 | ## mdBook 0.4.3 |
fc512014 | 360 | [9278b83...4df9ec9](https://github.com/rust-lang/mdBook/compare/9278b83...4df9ec9) |
1b1a35ee XL |
361 | |
362 | ### Added | |
363 | - Added `output.html.cname` option to emit a `CNAME` file which is used by | |
364 | GitHub Pages to know which domain is being used. | |
365 | [#1311](https://github.com/rust-lang/mdBook/pull/1311) | |
366 | ||
367 | ### Changed | |
368 | - `mdbook test` no longer stops on the first test failure, but instead will | |
369 | run all the tests. | |
370 | [#1313](https://github.com/rust-lang/mdBook/pull/1313) | |
371 | - Removed the `local` font source for Source Code Pro, as the locally | |
372 | installed font may not render properly on FireFox on macOS. | |
373 | [#1307](https://github.com/rust-lang/mdBook/pull/1307) | |
374 | ||
375 | ### Fixed | |
376 | - Added newline to end of `.nojekyll` file. | |
377 | [#1310](https://github.com/rust-lang/mdBook/pull/1310) | |
378 | - Fixed missing space before draft chapter titles. | |
379 | [#1309](https://github.com/rust-lang/mdBook/pull/1309) | |
380 | ||
3dfed10e XL |
381 | ## mdBook 0.4.2 |
382 | [649f355...9278b83](https://github.com/rust-lang/mdBook/compare/649f355...9278b83) | |
383 | ||
384 | ### Changed | |
385 | - The "show hidden lines" icon has changed from the "expand" icon to an "eye". | |
386 | [#1281](https://github.com/rust-lang/mdBook/pull/1281) | |
387 | - Updated highlight.js. This adds several languages: c, c-like (effectively | |
388 | cpp), csharp (replaces cs), kotlin, less, lua, php-template, plaintext, | |
389 | python-repl, r, scss, typescript. | |
390 | [#1277](https://github.com/rust-lang/mdBook/pull/1277) | |
391 | ||
392 | ### Fixed | |
393 | - Fixed SUMMARY links that contained newlines. | |
394 | [#1291](https://github.com/rust-lang/mdBook/pull/1291) | |
395 | - Fixed SUMMARY links that contain `%20` spaces. | |
396 | [#1293](https://github.com/rust-lang/mdBook/pull/1293) | |
397 | - Fixed favicon so that if only the png or svg is overridden, the other is not | |
398 | automatically included in the `<link>` tag. | |
399 | [#1272](https://github.com/rust-lang/mdBook/pull/1272) | |
400 | ||
401 | ## mdBook 0.4.1 | |
402 | [d4df7e7...649f355](https://github.com/rust-lang/mdBook/compare/d4df7e7...649f355) | |
403 | ||
404 | ### Changed | |
405 | - Removed several outdated dev-dependencies. | |
406 | [#1267](https://github.com/rust-lang/mdBook/pull/1267) | |
407 | ||
408 | ### Fixed | |
409 | - Fixed sidebar scrolling if the book includes part titles. | |
410 | [#1265](https://github.com/rust-lang/mdBook/pull/1265) | |
411 | - Don't include the default favicon if only one of the PNG or SVG is overridden. | |
412 | [#1266](https://github.com/rust-lang/mdBook/pull/1266) | |
413 | ||
f035d41b XL |
414 | ## mdBook 0.4.0 |
415 | [99ecd4f...d4df7e7](https://github.com/rust-lang/mdBook/compare/99ecd4f...d4df7e7) | |
416 | ||
417 | ### Breaking Changes | |
418 | - Several of the changes in the release have altered the public API of the | |
419 | mdbook library. | |
420 | - Many dependencies have been updated or replaced. | |
421 | This also removes the `--websocket-hostname` and `--websocket-port` from | |
422 | the `serve` command. | |
423 | [#1211](https://github.com/rust-lang/mdBook/pull/1211) | |
424 | - A new "404" page is now automatically rendered. This requires knowledge of | |
425 | the base URL of your site to work properly. If you decide to use this as | |
426 | your 404 page, you should set the `site-url` setting in the book | |
427 | configuration so mdbook can generate the links correctly. Alternatively you | |
428 | can disable the 404 page generation, or set up your own 404 handling in your | |
429 | web server. | |
430 | [#1221](https://github.com/rust-lang/mdBook/pull/1221) | |
3dfed10e XL |
431 | - The `debug` and `output` features have been removed as they were unused. |
432 | [#1211](https://github.com/rust-lang/mdBook/pull/1211) | |
f035d41b XL |
433 | - If you are using customized themes, you may want to consider setting the |
434 | `preferred-dark-theme` config setting, as it now defaults to "navy". | |
435 | [#1199](https://github.com/rust-lang/mdBook/pull/1199) | |
436 | - "Playpen" has been renamed to "playground". This is generally backwards | |
437 | compatible for users, but `{{#playpen}}` will now display warnings. This may | |
438 | impact books that have modified the "playpen" elements in the theme. | |
439 | [#1241](https://github.com/rust-lang/mdBook/pull/1241) | |
440 | - If a renderer is not installed, it is now treated as an error. If you want | |
441 | the old behavior of ignoring missing renderers, set the `optional` setting | |
442 | for that renderer. | |
443 | [#1122](https://github.com/rust-lang/mdBook/pull/1122) | |
3dfed10e XL |
444 | - If you have a custom favicon, you may need to look into adding an SVG |
445 | version, otherwise the default SVG icon will be displayed. | |
446 | [#1230](https://github.com/rust-lang/mdBook/pull/1230) | |
f035d41b XL |
447 | |
448 | ### Added | |
449 | - Added a new `[rust]` configuration section to `book.toml`, which allows | |
450 | setting the default edition with `edition = "2018"`. | |
451 | [#1163](https://github.com/rust-lang/mdBook/pull/1163) | |
452 | - Renderers can now be marked as `optional`, so that they will be ignored if | |
453 | the renderer is not installed. | |
454 | [#1122](https://github.com/rust-lang/mdBook/pull/1122) | |
455 | - Added `head.hbs` to allow adding content to the `<head>` section in HTML. | |
456 | [#1206](https://github.com/rust-lang/mdBook/pull/1206) | |
457 | - Added "draft chapters". These are chapters listed without a link to indicate | |
458 | content yet to be written. | |
459 | [#1153](https://github.com/rust-lang/mdBook/pull/1153) | |
460 | - Added "parts" to split a book into different sections. Headers can be added | |
461 | to `SUMMARY.md` to signify different sections. | |
462 | [#1171](https://github.com/rust-lang/mdBook/pull/1171) | |
463 | - Added generation of a "404" page for handling missing pages and broken links. | |
464 | [#1221](https://github.com/rust-lang/mdBook/pull/1221) | |
465 | - Added configuration section for specifying URL redirects. | |
466 | [#1237](https://github.com/rust-lang/mdBook/pull/1237) | |
467 | - Added an SVG favicon that works with light and dark colors schemes. | |
468 | [#1230](https://github.com/rust-lang/mdBook/pull/1230) | |
469 | ||
470 | ### Changed | |
471 | - Changed default Rust attribute of `allow(unused_variables)` to `allow(unused)`. | |
472 | [#1195](https://github.com/rust-lang/mdBook/pull/1195) | |
473 | - Fonts are now served locally instead of from the Google Fonts CDN. The | |
474 | `copy-fonts` option was added to disable this if you want to supply your own | |
475 | fonts. | |
476 | [#1188](https://github.com/rust-lang/mdBook/pull/1188) | |
477 | - Switched the built-in webserver for the `serve` command to a new | |
478 | implementation. This results in some internal differences in how websockets | |
479 | are handled, which removes the separate websocket options. This should also | |
480 | make it easier to serve multiple books at once. | |
481 | [#1211](https://github.com/rust-lang/mdBook/pull/1211) | |
482 | - The default dark theme is now "navy". | |
483 | [#1199](https://github.com/rust-lang/mdBook/pull/1199) | |
484 | - "Playpen" has been renamed to "playground", matching the actual name of the | |
485 | service which was renamed many years ago. | |
486 | [#1241](https://github.com/rust-lang/mdBook/pull/1241) | |
487 | ||
488 | ### Fixed | |
489 | - Links with the `+` symbol should now work. | |
490 | [#1208](https://github.com/rust-lang/mdBook/pull/1208) | |
491 | - The `MDBOOK_BOOK` environment variable now correctly allows overriding the | |
492 | entire book configuration. | |
493 | [#1207](https://github.com/rust-lang/mdBook/pull/1207) | |
494 | - The sidebar can no longer be dragged outside of the window. | |
495 | [#1229](https://github.com/rust-lang/mdBook/pull/1229) | |
496 | - Hide the Rust Playground "play" button for `no_run` code samples. | |
497 | [#1249](https://github.com/rust-lang/mdBook/pull/1249) | |
498 | - Fixed the `--dest-dir` command-line option for the `serve` and `watch` | |
499 | commands. | |
500 | [#1228](https://github.com/rust-lang/mdBook/pull/1228) | |
501 | - Hotkey handlers are now disabled in `text` input fields (for example, typing | |
502 | `S` in a custom text input field). | |
503 | [#1244](https://github.com/rust-lang/mdBook/pull/1244) | |
504 | ||
f9f354fc XL |
505 | ## mdBook 0.3.7 |
506 | [88684d8...99ecd4f](https://github.com/rust-lang/mdBook/compare/88684d8...99ecd4f) | |
507 | ||
508 | ### Changed | |
509 | - Code spans in headers are no longer highlighted as code. | |
510 | [#1162](https://github.com/rust-lang/mdBook/pull/1162) | |
511 | - The sidebar will now scroll the activate page to the middle instead of the top. | |
512 | [#1161](https://github.com/rust-lang/mdBook/pull/1161) | |
513 | - Reverted change to reject build output within the `src` directory, and | |
514 | instead add a check that prevents infinite copies. | |
515 | [#1181](https://github.com/rust-lang/mdBook/pull/1181) | |
516 | [#1026](https://github.com/rust-lang/mdBook/pull/1026) | |
517 | ||
518 | ### Fixed | |
519 | - Fixed sidebar line-height jumping for collapsed chapters. | |
520 | [#1182](https://github.com/rust-lang/mdBook/pull/1182) | |
521 | - Fixed theme selector focus. | |
522 | [#1170](https://github.com/rust-lang/mdBook/pull/1170) | |
523 | ||
524 | ## mdBook 0.3.6 | |
525 | [efdb832...88684d8](https://github.com/rust-lang/mdBook/compare/efdb832...88684d8) | |
526 | ||
527 | ### Added | |
528 | - `MDBook::execute_build_process` is now publicly accessible in the API so | |
529 | that plugins can more easily initiate the build process. | |
530 | [#1099](https://github.com/rust-lang/mdBook/pull/1099) | |
531 | ||
532 | ### Changed | |
533 | - Use a different color for Ayu theme's highlighting for Rust attributes (uses | |
534 | a bright color instead of the comment color). | |
535 | [#1133](https://github.com/rust-lang/mdBook/pull/1133) | |
536 | - Adjusted spacing of sidebar entries. | |
537 | [#1137](https://github.com/rust-lang/mdBook/pull/1137) | |
538 | - Slightly adjusted line-height of `<p>`, `<ul>`, and `<ol>`. | |
539 | [#1136](https://github.com/rust-lang/mdBook/pull/1136) | |
540 | - Handlebars updated to 3.0. | |
541 | [#1130](https://github.com/rust-lang/mdBook/pull/1130) | |
542 | ||
543 | ### Fixed | |
544 | - Fix an issue with sidebar scroll position on reload. | |
545 | [#1108](https://github.com/rust-lang/mdBook/pull/1108) | |
546 | - `mdbook serve` will retain the current scroll position when the page is reloaded. | |
547 | [#1097](https://github.com/rust-lang/mdBook/pull/1097) | |
548 | - Fixed the page name if the book didn't have a title to not be prefixed with ` - `. | |
549 | [#1145](https://github.com/rust-lang/mdBook/pull/1145) | |
550 | - HTML attributes `rel=next` and `rel=previous` are now supported in "wide" | |
551 | mode (previously they were only set in narrow mode). | |
552 | [#1150](https://github.com/rust-lang/mdBook/pull/1150) | |
553 | - Prevent recursive copies when the destination directory is contained in the | |
554 | source directory. | |
555 | [#1135](https://github.com/rust-lang/mdBook/pull/1135) | |
556 | - Adjusted the menu bar animation to not immediately obscure the top content. | |
557 | [#989](https://github.com/rust-lang/mdBook/pull/989) | |
558 | - Fix for comments in SUMMARY.md that appear between items. | |
559 | [#1167](https://github.com/rust-lang/mdBook/pull/1167) | |
560 | ||
e74abb32 XL |
561 | ## mdBook 0.3.5 |
562 | [6e0d0fa...efdb832](https://github.com/rust-lang/mdBook/compare/6e0d0fa...efdb832) | |
563 | ||
564 | ### Changed | |
565 | - The `default-theme` config setting is now case-insensitive. | |
566 | [#1079](https://github.com/rust-lang/mdBook/pull/1079) | |
567 | ||
568 | ### Fixed | |
569 | - Fixed `#` hidden Rust code lines not rendering properly. | |
570 | [#1088](https://github.com/rust-lang/mdBook/pull/1088) | |
571 | - Updated pulldown-cmark to 0.6.1, fixing several issues. | |
572 | [#1021](https://github.com/rust-lang/mdBook/pull/1021) | |
573 | ||
574 | ## mdBook 0.3.4 | |
575 | [e5f77aa...6e0d0fa](https://github.com/rust-lang/mdBook/compare/e5f77aa...6e0d0fa) | |
576 | ||
577 | ### Changed | |
578 | - Switch to relative `rem` font sizes from `px`. | |
579 | [#894](https://github.com/rust-lang/mdBook/pull/894) | |
580 | - Migrated repository to https://github.com/rust-lang/mdBook/ | |
581 | [#1083](https://github.com/rust-lang/mdBook/pull/1083) | |
582 | ||
583 | ## mdBook 0.3.3 | |
584 | [2b649fe...e5f77aa](https://github.com/rust-lang/mdBook/compare/2b649fe...e5f77aa) | |
585 | ||
586 | ### Changed | |
587 | - Improvements to the automatic dark theme selection. | |
588 | [#1069](https://github.com/rust-lang/mdBook/pull/1069) | |
589 | - Fragment links now prevent scrolling the header behind the menu bar. | |
590 | [#1077](https://github.com/rust-lang/mdBook/pull/1077) | |
591 | ||
592 | ### Fixed | |
593 | - Fixed error when building a book that has a spacer immediately after the | |
594 | first chapter. | |
595 | [#1075](https://github.com/rust-lang/mdBook/pull/1075) | |
596 | ||
597 | ## mdBook 0.3.2 | |
598 | [9cd47eb...2b649fe](https://github.com/rust-lang/mdBook/compare/9cd47eb...2b649fe) | |
599 | ||
600 | ### Added | |
601 | - Added a markdown renderer, which is off by default. This may be useful for | |
602 | debugging preprocessors. | |
603 | [#1018](https://github.com/rust-lang/mdBook/pull/1018) | |
604 | - Code samples may now include line numbers with the | |
605 | `output.html.playpen.line-numbers` configuration value. | |
606 | [#1035](https://github.com/rust-lang/mdBook/pull/1035) | |
607 | - The `watch` and `serve` commands will now ignore files listed in | |
608 | `.gitignore`. | |
609 | [#1044](https://github.com/rust-lang/mdBook/pull/1044) | |
610 | - Added automatic dark-theme detection based on the CSS `prefers-color-scheme` | |
611 | feature. This may be enabled by setting `output.html.preferred-dark-theme` | |
612 | to your preferred dark theme. | |
613 | [#1037](https://github.com/rust-lang/mdBook/pull/1037) | |
614 | - Added `rustdoc_include` preprocessor. This makes it easier to include | |
615 | portions of an external Rust source file. The rest of the file is hidden, | |
616 | but the user may expand it to see the entire file, and will continue to work | |
617 | with `mdbook test`. | |
618 | [#1003](https://github.com/rust-lang/mdBook/pull/1003) | |
619 | - Added Ctrl-Enter shortcut to the playpen editor to automatically run the | |
620 | sample. | |
621 | [#1066](https://github.com/rust-lang/mdBook/pull/1066) | |
622 | - Added `output.html.playpen.copyable` configuration option to disable | |
623 | the copy button. | |
624 | [#1050](https://github.com/rust-lang/mdBook/pull/1050) | |
625 | - Added ability to dynamically expand and fold sections within the sidebar. | |
626 | See the `output.html.fold` configuration to enable this feature. | |
627 | [#1027](https://github.com/rust-lang/mdBook/pull/1027) | |
628 | ||
629 | ### Changed | |
630 | - Use standard `scrollbar-color` CSS along with webkit extension | |
631 | [#816](https://github.com/rust-lang/mdBook/pull/816) | |
632 | - The renderer build directory is no longer deleted before the renderer is | |
633 | run. This allows a backend to cache results between runs. | |
634 | [#985](https://github.com/rust-lang/mdBook/pull/985) | |
635 | - Next/prev links now highlight on hover to indicate it is clickable. | |
636 | [#994](https://github.com/rust-lang/mdBook/pull/994) | |
637 | - Increase padding of table headers. | |
638 | [#824](https://github.com/rust-lang/mdBook/pull/824) | |
639 | - Errors in `[output.html]` config are no longer ignored. | |
640 | [#1033](https://github.com/rust-lang/mdBook/pull/1033) | |
641 | - Updated highlight.js for syntax highlighting updates (primarily to add | |
642 | async/await to Rust highlighting). | |
643 | [#1041](https://github.com/rust-lang/mdBook/pull/1041) | |
644 | - Raised minimum supported rust version to 1.35. | |
645 | [#1003](https://github.com/rust-lang/mdBook/pull/1003) | |
646 | - Hidden code lines are no longer dynamically removed via JavaScript, but | |
647 | instead managed with CSS. | |
648 | [#846](https://github.com/rust-lang/mdBook/pull/846) | |
649 | [#1065](https://github.com/rust-lang/mdBook/pull/1065) | |
650 | - Changed the default font set for the ACE editor, giving preference to | |
651 | "Source Code Pro". | |
652 | [#1062](https://github.com/rust-lang/mdBook/pull/1062) | |
653 | - Windows 32-bit releases are no longer published. | |
654 | [#1071](https://github.com/rust-lang/mdBook/pull/1071) | |
655 | ||
656 | ### Fixed | |
657 | - Fixed sidebar auto-scrolling. | |
658 | [#1052](https://github.com/rust-lang/mdBook/pull/1052) | |
659 | - Fixed error message when running `clean` multiple times. | |
660 | [#1055](https://github.com/rust-lang/mdBook/pull/1055) | |
661 | - Actually fix the "next" link on index.html. The previous fix didn't work. | |
662 | [#1005](https://github.com/rust-lang/mdBook/pull/1005) | |
663 | - Stop using `inline-block` for `inline code`, fixing selection highlighting | |
664 | and some rendering issues. | |
665 | [#1058](https://github.com/rust-lang/mdBook/pull/1058) | |
666 | - Fix header auto-hide on browsers with momentum scrolling that allows | |
667 | negative `scrollTop`. | |
668 | [#1070](https://github.com/rust-lang/mdBook/pull/1070) | |
669 | ||
416331ca | 670 | ## mdBook 0.3.1 |
e74abb32 | 671 | [69a08ef...9cd47eb](https://github.com/rust-lang/mdBook/compare/69a08ef...9cd47eb) |
416331ca XL |
672 | |
673 | ### Added | |
674 | - 🔥 Added ability to include files using anchor points instead of line numbers. | |
e74abb32 | 675 | [#851](https://github.com/rust-lang/mdBook/pull/851) |
416331ca XL |
676 | - Added `language` configuration value to set the language of the book, which |
677 | will affect things like the `<html lang="en">` tag. | |
e74abb32 | 678 | [#941](https://github.com/rust-lang/mdBook/pull/941) |
416331ca XL |
679 | |
680 | ### Changed | |
681 | - Updated to handlebars 2.0. | |
e74abb32 | 682 | [#977](https://github.com/rust-lang/mdBook/pull/977) |
416331ca XL |
683 | |
684 | ### Fixed | |
685 | - Fixed memory leak warning. | |
e74abb32 | 686 | [#967](https://github.com/rust-lang/mdBook/pull/967) |
416331ca | 687 | - Fix more print.html links. |
e74abb32 | 688 | [#963](https://github.com/rust-lang/mdBook/pull/963) |
416331ca | 689 | - Fixed crash on some unicode input. |
e74abb32 | 690 | [#978](https://github.com/rust-lang/mdBook/pull/978) |
416331ca | 691 | |
dc9dc135 | 692 | ## mdBook 0.3.0 |
e74abb32 | 693 | [6cbc41d...69a08ef](https://github.com/rust-lang/mdBook/compare/6cbc41d...69a08ef) |
dc9dc135 XL |
694 | |
695 | ### Added | |
696 | - Added ability to resize the sidebar. | |
e74abb32 | 697 | [#849](https://github.com/rust-lang/mdBook/pull/849) |
dc9dc135 XL |
698 | - Added `load_with_config_and_summary` function to `MDBook` to be able to |
699 | build a book with a custom `Summary`. | |
e74abb32 | 700 | [#883](https://github.com/rust-lang/mdBook/pull/883) |
dc9dc135 | 701 | - Set `noindex` on `print.html` page to prevent robots from indexing it. |
e74abb32 | 702 | [#844](https://github.com/rust-lang/mdBook/pull/844) |
dc9dc135 | 703 | - Added support for ~~strikethrough~~ and GitHub-style tasklists. |
e74abb32 | 704 | [#952](https://github.com/rust-lang/mdBook/pull/952) |
dc9dc135 XL |
705 | |
706 | ### Changed | |
707 | - Command-line help output is now colored. | |
e74abb32 | 708 | [#861](https://github.com/rust-lang/mdBook/pull/861) |
dc9dc135 XL |
709 | - The build directory is now deleted before rendering starts, instead of after |
710 | if finishes. | |
e74abb32 | 711 | [#878](https://github.com/rust-lang/mdBook/pull/878) |
dc9dc135 | 712 | - Removed dependency on `same-file` crate. |
e74abb32 | 713 | [#903](https://github.com/rust-lang/mdBook/pull/903) |
dc9dc135 | 714 | - 💥 Renamed `with_preprecessor` to `with_preprocessor`. |
e74abb32 | 715 | [#906](https://github.com/rust-lang/mdBook/pull/906) |
dc9dc135 | 716 | - Updated ACE editor to 1.4.4, should remove a JavaScript console warning. |
e74abb32 | 717 | [#935](https://github.com/rust-lang/mdBook/pull/935) |
dc9dc135 | 718 | - Dependencies have been updated. |
e74abb32 XL |
719 | [#934](https://github.com/rust-lang/mdBook/pull/934) |
720 | [#945](https://github.com/rust-lang/mdBook/pull/945) | |
dc9dc135 XL |
721 | - Highlight.js has been updated. This fixes some TOML highlighting, and adds |
722 | Julia support. | |
e74abb32 | 723 | [#942](https://github.com/rust-lang/mdBook/pull/942) |
dc9dc135 XL |
724 | - 🔥 Updated to pulldown-cmark 0.5. This may have significant changes to the |
725 | formatting of existing books, as the newer version has more accurate | |
726 | interpretation of the CommonMark spec and a large number of bug fixes and | |
727 | changes. | |
e74abb32 | 728 | [#898](https://github.com/rust-lang/mdBook/pull/898) |
dc9dc135 | 729 | - The `diff` language should now highlight correctly. |
e74abb32 | 730 | [#943](https://github.com/rust-lang/mdBook/pull/943) |
dc9dc135 | 731 | - Make the blank region of a header not clickable. |
e74abb32 | 732 | [#948](https://github.com/rust-lang/mdBook/pull/948) |
dc9dc135 XL |
733 | - Rustdoc tests now use the preprocessed content instead of the raw, |
734 | unpreprocessed content. | |
e74abb32 | 735 | [#891](https://github.com/rust-lang/mdBook/pull/891) |
dc9dc135 XL |
736 | |
737 | ### Fixed | |
738 | - Fixed file change detection so that `mdbook serve` only reloads once when | |
739 | multiple files are changed at once. | |
e74abb32 | 740 | [#870](https://github.com/rust-lang/mdBook/pull/870) |
dc9dc135 | 741 | - Fixed on-hover color highlighting for links in sidebar. |
e74abb32 | 742 | [#834](https://github.com/rust-lang/mdBook/pull/834) |
dc9dc135 | 743 | - Fixed loss of focus when clicking the "Copy" button in code blocks. |
e74abb32 | 744 | [#867](https://github.com/rust-lang/mdBook/pull/867) |
dc9dc135 | 745 | - Fixed incorrectly stripping the path for `additional-js` files. |
e74abb32 | 746 | [#796](https://github.com/rust-lang/mdBook/pull/796) |
dc9dc135 | 747 | - Fixed color of `code spans` that are links. |
e74abb32 | 748 | [#905](https://github.com/rust-lang/mdBook/pull/905) |
dc9dc135 | 749 | - Fixed "next" navigation on index.html. |
e74abb32 | 750 | [#916](https://github.com/rust-lang/mdBook/pull/916) |
dc9dc135 | 751 | - Fixed keyboard chapter navigation for `file` urls. |
e74abb32 | 752 | [#915](https://github.com/rust-lang/mdBook/pull/915) |
dc9dc135 | 753 | - Fixed bad wrapping for inline code on some browsers. |
e74abb32 | 754 | [#818](https://github.com/rust-lang/mdBook/pull/818) |
dc9dc135 | 755 | - Properly load an existing `SUMMARY.md` in `mdbook init`. |
e74abb32 | 756 | [#841](https://github.com/rust-lang/mdBook/pull/841) |
dc9dc135 | 757 | - Fixed some broken links in `print.html`. |
e74abb32 | 758 | [#871](https://github.com/rust-lang/mdBook/pull/871) |
dc9dc135 | 759 | - The Rust Playground link now supports the 2018 edition. |
e74abb32 | 760 | [#946](https://github.com/rust-lang/mdBook/pull/946) |
dc9dc135 XL |
761 | |
762 | ## mdBook 0.2.3 (2018-01-18) | |
e74abb32 | 763 | [2c20c99...6cbc41d](https://github.com/rust-lang/mdBook/compare/2c20c99...6cbc41d) |
dc9dc135 XL |
764 | |
765 | ### Added | |
766 | - Added an optional button to the top of the page which will link to a git | |
767 | repository. Use the `git-repository-url` and `git-repository-icon` options | |
768 | in the `[output.html]` section to enable it and set its appearance. | |
e74abb32 | 769 | [#802](https://github.com/rust-lang/mdBook/pull/802) |
dc9dc135 | 770 | - Added a `default-theme` option to the `[output.html]` section. |
e74abb32 | 771 | [#804](https://github.com/rust-lang/mdBook/pull/804) |
dc9dc135 XL |
772 | |
773 | ### Changed | |
774 | - 💥 Header ID anchors no longer add an arbitrary `a` character for headers | |
775 | that start with a non-ascii-alphabetic character. | |
e74abb32 | 776 | [#788](https://github.com/rust-lang/mdBook/pull/788) |
dc9dc135 XL |
777 | |
778 | ### Fixed | |
779 | - Fix websocket hostname usage | |
e74abb32 | 780 | [#865](https://github.com/rust-lang/mdBook/pull/865) |
dc9dc135 | 781 | - Fixing links in print.html |
e74abb32 | 782 | [#866](https://github.com/rust-lang/mdBook/pull/866) |
dc9dc135 XL |
783 | |
784 | ## mdBook 0.2.2 (2018-10-19) | |
e74abb32 | 785 | [7e2e095...2c20c99](https://github.com/rust-lang/mdBook/compare/7e2e095...2c20c99) |
dc9dc135 XL |
786 | |
787 | ### Added | |
788 | - 🎉 Process-based custom preprocessors. See [the | |
e74abb32 | 789 | docs](https://rust-lang.github.io/mdBook/for_developers/preprocessors.html) |
dc9dc135 | 790 | for more. |
e74abb32 | 791 | [#792](https://github.com/rust-lang/mdBook/pull/792) |
dc9dc135 XL |
792 | |
793 | - 🎉 Configurable preprocessors. | |
794 | ||
795 | Added `build.use-default-preprocessors` boolean TOML key to allow disabling | |
796 | the built-in `links` and `index` preprocessors. | |
797 | ||
798 | Added `[preprocessor]` TOML tables to configure each preprocessor. | |
799 | ||
800 | Specifying `[preprocessor.links]` or `[preprocessor.index]` will enable the | |
801 | respective built-in preprocessor if `build.use-default-preprocessors` is | |
802 | `false`. | |
803 | ||
804 | Added `fn supports_renderer(&self, renderer: &str) -> bool` to the | |
805 | `Preprocessor` trait to specify if the preprocessor supports the given | |
806 | renderer. The default implementation always returns `true`. | |
807 | ||
808 | `Preprocessor::run` now takes a book by value instead of a mutable | |
809 | reference. It should return a `Book` value with the intended modifications. | |
810 | ||
811 | Added `PreprocessorContext::renderer` to indicate the renderer being used. | |
812 | ||
e74abb32 XL |
813 | [#658](https://github.com/rust-lang/mdBook/pull/658) |
814 | [#787](https://github.com/rust-lang/mdBook/pull/787) | |
dc9dc135 XL |
815 | |
816 | ### Fixed | |
817 | - Fix paths to additional CSS and JavaScript files | |
e74abb32 | 818 | [#777](https://github.com/rust-lang/mdBook/pull/777) |
dc9dc135 XL |
819 | - Ensure section numbers are correctly incremented after a horizontal |
820 | separator | |
e74abb32 | 821 | [#790](https://github.com/rust-lang/mdBook/pull/790) |
dc9dc135 XL |
822 | |
823 | ## mdBook 0.2.1 (2018-08-22) | |
e74abb32 | 824 | [91ffca1...7e2e095](https://github.com/rust-lang/mdBook/compare/91ffca1...7e2e095) |
dc9dc135 XL |
825 | |
826 | ### Changed | |
827 | - Update to handlebars-rs 1.0 | |
e74abb32 | 828 | [#761](https://github.com/rust-lang/mdBook/pull/761) |
dc9dc135 XL |
829 | |
830 | ### Fixed | |
831 | - Fix table colors, broken by Stylus -> CSS transition | |
e74abb32 | 832 | [#765](https://github.com/rust-lang/mdBook/pull/765) |
dc9dc135 XL |
833 | |
834 | ## mdBook 0.2.0 (2018-08-02) | |
835 | ||
836 | ### Changed | |
837 | - 💥 This release changes how links are handled in mdBook. Previously, relative | |
838 | links were interpreted relative to the book's root. In `0.2.0`+ links are | |
839 | relative to the page they are in, and use the `.md` extension. This has [several | |
e74abb32 | 840 | advantages](https://github.com/rust-lang/mdBook/pull/603#issue-166701447), |
dc9dc135 XL |
841 | such as making links work in other markdown viewers like GitHub. You will |
842 | likely have to change links in your book to accommodate this change. For | |
843 | example, a book with this layout: | |
844 | ||
845 | ``` | |
846 | chapter_1/ | |
847 | section_1.md | |
848 | section_2.md | |
849 | SUMMARY.md | |
850 | ``` | |
851 | ||
852 | Previously a link in `section_1.md` to `section_2.md` would look like this: | |
853 | ```markdown | |
854 | [section_2](chapter_1/section_2.html) | |
855 | ``` | |
856 | ||
857 | Now it must be changed to this: | |
858 | ```markdown | |
859 | [section_2](section_2.md) | |
860 | ``` | |
861 | ||
862 | - 💥 `mdbook test --library-path` now accepts a comma-delimited list of | |
863 | arguments rather than taking all following arguments. This makes it easier | |
864 | to handle the trailing book directory argument without always needing to put | |
865 | ` -- ` before it. Multiple instances of the option continue to be accepted: | |
866 | `mdbook test -L foo -L bar`. | |
867 | ||
868 | - 💥 `mdbook serve` has some of its options renamed for clarity. See `mdbook | |
869 | help serve` for details. | |
870 | ||
871 | - Embedded rust playpens now use the "stable" playground API. | |
e74abb32 | 872 | [#754](https://github.com/rust-lang/mdBook/pull/754) |
dc9dc135 XL |
873 | |
874 | ### Fixed | |
875 | - Escaped includes (`\{{#include file.rs}}`) will now render correctly. | |
e74abb32 | 876 | [f30ce01](https://github.com/rust-lang/mdBook/commit/f30ce0184d71e342141145472bf816419d30a2c5) |
dc9dc135 XL |
877 | - `index.html` will now render correctly when the book's first section is |
878 | inside a subdirectory. | |
e74abb32 | 879 | [#756](https://github.com/rust-lang/mdBook/pull/756) |