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
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
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
"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
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
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
Added
Added a new [rust] configuration section to book.toml, which allows
setting the default edition with edition = "2018".
#1163
Renderers can now be marked as optional, so that they will be ignored if
Commits
f37ea9a Merge pull request #1269 from ehuss/update-changelog
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme
Additionally, you can set the following in the `.dependabot/config.yml` file in this repo:
- Update frequency
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Updates the requirements on mdbook to permit the latest version.
Release notes
Sourced from mdbook's releases.
Changelog
Sourced from mdbook's changelog.
Commits
f37ea9a
Merge pull request #1269 from ehuss/update-changelog8f74804
Update changelog.649f355
Merge pull request #1266 from ehuss/favicon-no-default8432df1
Merge pull request #1265 from ehuss/part-title-active9eba9ed
Update select dependency to 0.5 (#1267)b0c6f2d
Don't copy default favicon if at least one is overridden.6e0688a
Update changelog, add note about SVG icon.e9951af
Fix sidebar scrolling with part titles.138dc69
Merge pull request #1264 from ehuss/update-changelog91b2fb8
Update changelog.Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in the `.dependabot/config.yml` file in this repo: - Update frequency - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired)