Merge pull request #1083 from rust-lang/move-from-nursery
rust-lang-nursery -> rust-lang
This commit is contained in:
commit
6e0d0facff
168
CHANGELOG.md
168
CHANGELOG.md
|
@ -1,214 +1,214 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## mdBook 0.3.3
|
## mdBook 0.3.3
|
||||||
[2b649fe...e5f77aa](https://github.com/rust-lang-nursery/mdBook/compare/2b649fe...e5f77aa)
|
[2b649fe...e5f77aa](https://github.com/rust-lang/mdBook/compare/2b649fe...e5f77aa)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Improvements to the automatic dark theme selection.
|
- Improvements to the automatic dark theme selection.
|
||||||
[#1069](https://github.com/rust-lang-nursery/mdBook/pull/1069)
|
[#1069](https://github.com/rust-lang/mdBook/pull/1069)
|
||||||
- Fragment links now prevent scrolling the header behind the menu bar.
|
- Fragment links now prevent scrolling the header behind the menu bar.
|
||||||
[#1077](https://github.com/rust-lang-nursery/mdBook/pull/1077)
|
[#1077](https://github.com/rust-lang/mdBook/pull/1077)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fixed error when building a book that has a spacer immediately after the
|
- Fixed error when building a book that has a spacer immediately after the
|
||||||
first chapter.
|
first chapter.
|
||||||
[#1075](https://github.com/rust-lang-nursery/mdBook/pull/1075)
|
[#1075](https://github.com/rust-lang/mdBook/pull/1075)
|
||||||
|
|
||||||
## mdBook 0.3.2
|
## mdBook 0.3.2
|
||||||
[9cd47eb...2b649fe](https://github.com/rust-lang-nursery/mdBook/compare/9cd47eb...2b649fe)
|
[9cd47eb...2b649fe](https://github.com/rust-lang/mdBook/compare/9cd47eb...2b649fe)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Added a markdown renderer, which is off by default. This may be useful for
|
- Added a markdown renderer, which is off by default. This may be useful for
|
||||||
debugging preprocessors.
|
debugging preprocessors.
|
||||||
[#1018](https://github.com/rust-lang-nursery/mdBook/pull/1018)
|
[#1018](https://github.com/rust-lang/mdBook/pull/1018)
|
||||||
- Code samples may now include line numbers with the
|
- Code samples may now include line numbers with the
|
||||||
`output.html.playpen.line-numbers` configuration value.
|
`output.html.playpen.line-numbers` configuration value.
|
||||||
[#1035](https://github.com/rust-lang-nursery/mdBook/pull/1035)
|
[#1035](https://github.com/rust-lang/mdBook/pull/1035)
|
||||||
- The `watch` and `serve` commands will now ignore files listed in
|
- The `watch` and `serve` commands will now ignore files listed in
|
||||||
`.gitignore`.
|
`.gitignore`.
|
||||||
[#1044](https://github.com/rust-lang-nursery/mdBook/pull/1044)
|
[#1044](https://github.com/rust-lang/mdBook/pull/1044)
|
||||||
- Added automatic dark-theme detection based on the CSS `prefers-color-scheme`
|
- Added automatic dark-theme detection based on the CSS `prefers-color-scheme`
|
||||||
feature. This may be enabled by setting `output.html.preferred-dark-theme`
|
feature. This may be enabled by setting `output.html.preferred-dark-theme`
|
||||||
to your preferred dark theme.
|
to your preferred dark theme.
|
||||||
[#1037](https://github.com/rust-lang-nursery/mdBook/pull/1037)
|
[#1037](https://github.com/rust-lang/mdBook/pull/1037)
|
||||||
- Added `rustdoc_include` preprocessor. This makes it easier to include
|
- Added `rustdoc_include` preprocessor. This makes it easier to include
|
||||||
portions of an external Rust source file. The rest of the file is hidden,
|
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
|
but the user may expand it to see the entire file, and will continue to work
|
||||||
with `mdbook test`.
|
with `mdbook test`.
|
||||||
[#1003](https://github.com/rust-lang-nursery/mdBook/pull/1003)
|
[#1003](https://github.com/rust-lang/mdBook/pull/1003)
|
||||||
- Added Ctrl-Enter shortcut to the playpen editor to automatically run the
|
- Added Ctrl-Enter shortcut to the playpen editor to automatically run the
|
||||||
sample.
|
sample.
|
||||||
[#1066](https://github.com/rust-lang-nursery/mdBook/pull/1066)
|
[#1066](https://github.com/rust-lang/mdBook/pull/1066)
|
||||||
- Added `output.html.playpen.copyable` configuration option to disable
|
- Added `output.html.playpen.copyable` configuration option to disable
|
||||||
the copy button.
|
the copy button.
|
||||||
[#1050](https://github.com/rust-lang-nursery/mdBook/pull/1050)
|
[#1050](https://github.com/rust-lang/mdBook/pull/1050)
|
||||||
- Added ability to dynamically expand and fold sections within the sidebar.
|
- Added ability to dynamically expand and fold sections within the sidebar.
|
||||||
See the `output.html.fold` configuration to enable this feature.
|
See the `output.html.fold` configuration to enable this feature.
|
||||||
[#1027](https://github.com/rust-lang-nursery/mdBook/pull/1027)
|
[#1027](https://github.com/rust-lang/mdBook/pull/1027)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Use standard `scrollbar-color` CSS along with webkit extension
|
- Use standard `scrollbar-color` CSS along with webkit extension
|
||||||
[#816](https://github.com/rust-lang-nursery/mdBook/pull/816)
|
[#816](https://github.com/rust-lang/mdBook/pull/816)
|
||||||
- The renderer build directory is no longer deleted before the renderer is
|
- The renderer build directory is no longer deleted before the renderer is
|
||||||
run. This allows a backend to cache results between runs.
|
run. This allows a backend to cache results between runs.
|
||||||
[#985](https://github.com/rust-lang-nursery/mdBook/pull/985)
|
[#985](https://github.com/rust-lang/mdBook/pull/985)
|
||||||
- Next/prev links now highlight on hover to indicate it is clickable.
|
- Next/prev links now highlight on hover to indicate it is clickable.
|
||||||
[#994](https://github.com/rust-lang-nursery/mdBook/pull/994)
|
[#994](https://github.com/rust-lang/mdBook/pull/994)
|
||||||
- Increase padding of table headers.
|
- Increase padding of table headers.
|
||||||
[#824](https://github.com/rust-lang-nursery/mdBook/pull/824)
|
[#824](https://github.com/rust-lang/mdBook/pull/824)
|
||||||
- Errors in `[output.html]` config are no longer ignored.
|
- Errors in `[output.html]` config are no longer ignored.
|
||||||
[#1033](https://github.com/rust-lang-nursery/mdBook/pull/1033)
|
[#1033](https://github.com/rust-lang/mdBook/pull/1033)
|
||||||
- Updated highlight.js for syntax highlighting updates (primarily to add
|
- Updated highlight.js for syntax highlighting updates (primarily to add
|
||||||
async/await to Rust highlighting).
|
async/await to Rust highlighting).
|
||||||
[#1041](https://github.com/rust-lang-nursery/mdBook/pull/1041)
|
[#1041](https://github.com/rust-lang/mdBook/pull/1041)
|
||||||
- Raised minimum supported rust version to 1.35.
|
- Raised minimum supported rust version to 1.35.
|
||||||
[#1003](https://github.com/rust-lang-nursery/mdBook/pull/1003)
|
[#1003](https://github.com/rust-lang/mdBook/pull/1003)
|
||||||
- Hidden code lines are no longer dynamically removed via JavaScript, but
|
- Hidden code lines are no longer dynamically removed via JavaScript, but
|
||||||
instead managed with CSS.
|
instead managed with CSS.
|
||||||
[#846](https://github.com/rust-lang-nursery/mdBook/pull/846)
|
[#846](https://github.com/rust-lang/mdBook/pull/846)
|
||||||
[#1065](https://github.com/rust-lang-nursery/mdBook/pull/1065)
|
[#1065](https://github.com/rust-lang/mdBook/pull/1065)
|
||||||
- Changed the default font set for the ACE editor, giving preference to
|
- Changed the default font set for the ACE editor, giving preference to
|
||||||
"Source Code Pro".
|
"Source Code Pro".
|
||||||
[#1062](https://github.com/rust-lang-nursery/mdBook/pull/1062)
|
[#1062](https://github.com/rust-lang/mdBook/pull/1062)
|
||||||
- Windows 32-bit releases are no longer published.
|
- Windows 32-bit releases are no longer published.
|
||||||
[#1071](https://github.com/rust-lang-nursery/mdBook/pull/1071)
|
[#1071](https://github.com/rust-lang/mdBook/pull/1071)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fixed sidebar auto-scrolling.
|
- Fixed sidebar auto-scrolling.
|
||||||
[#1052](https://github.com/rust-lang-nursery/mdBook/pull/1052)
|
[#1052](https://github.com/rust-lang/mdBook/pull/1052)
|
||||||
- Fixed error message when running `clean` multiple times.
|
- Fixed error message when running `clean` multiple times.
|
||||||
[#1055](https://github.com/rust-lang-nursery/mdBook/pull/1055)
|
[#1055](https://github.com/rust-lang/mdBook/pull/1055)
|
||||||
- Actually fix the "next" link on index.html. The previous fix didn't work.
|
- Actually fix the "next" link on index.html. The previous fix didn't work.
|
||||||
[#1005](https://github.com/rust-lang-nursery/mdBook/pull/1005)
|
[#1005](https://github.com/rust-lang/mdBook/pull/1005)
|
||||||
- Stop using `inline-block` for `inline code`, fixing selection highlighting
|
- Stop using `inline-block` for `inline code`, fixing selection highlighting
|
||||||
and some rendering issues.
|
and some rendering issues.
|
||||||
[#1058](https://github.com/rust-lang-nursery/mdBook/pull/1058)
|
[#1058](https://github.com/rust-lang/mdBook/pull/1058)
|
||||||
- Fix header auto-hide on browsers with momentum scrolling that allows
|
- Fix header auto-hide on browsers with momentum scrolling that allows
|
||||||
negative `scrollTop`.
|
negative `scrollTop`.
|
||||||
[#1070](https://github.com/rust-lang-nursery/mdBook/pull/1070)
|
[#1070](https://github.com/rust-lang/mdBook/pull/1070)
|
||||||
|
|
||||||
## mdBook 0.3.1
|
## mdBook 0.3.1
|
||||||
[69a08ef...9cd47eb](https://github.com/rust-lang-nursery/mdBook/compare/69a08ef...9cd47eb)
|
[69a08ef...9cd47eb](https://github.com/rust-lang/mdBook/compare/69a08ef...9cd47eb)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- 🔥 Added ability to include files using anchor points instead of line numbers.
|
- 🔥 Added ability to include files using anchor points instead of line numbers.
|
||||||
[#851](https://github.com/rust-lang-nursery/mdBook/pull/851)
|
[#851](https://github.com/rust-lang/mdBook/pull/851)
|
||||||
- Added `language` configuration value to set the language of the book, which
|
- Added `language` configuration value to set the language of the book, which
|
||||||
will affect things like the `<html lang="en">` tag.
|
will affect things like the `<html lang="en">` tag.
|
||||||
[#941](https://github.com/rust-lang-nursery/mdBook/pull/941)
|
[#941](https://github.com/rust-lang/mdBook/pull/941)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Updated to handlebars 2.0.
|
- Updated to handlebars 2.0.
|
||||||
[#977](https://github.com/rust-lang-nursery/mdBook/pull/977)
|
[#977](https://github.com/rust-lang/mdBook/pull/977)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fixed memory leak warning.
|
- Fixed memory leak warning.
|
||||||
[#967](https://github.com/rust-lang-nursery/mdBook/pull/967)
|
[#967](https://github.com/rust-lang/mdBook/pull/967)
|
||||||
- Fix more print.html links.
|
- Fix more print.html links.
|
||||||
[#963](https://github.com/rust-lang-nursery/mdBook/pull/963)
|
[#963](https://github.com/rust-lang/mdBook/pull/963)
|
||||||
- Fixed crash on some unicode input.
|
- Fixed crash on some unicode input.
|
||||||
[#978](https://github.com/rust-lang-nursery/mdBook/pull/978)
|
[#978](https://github.com/rust-lang/mdBook/pull/978)
|
||||||
|
|
||||||
## mdBook 0.3.0
|
## mdBook 0.3.0
|
||||||
[6cbc41d...69a08ef](https://github.com/rust-lang-nursery/mdBook/compare/6cbc41d...69a08ef)
|
[6cbc41d...69a08ef](https://github.com/rust-lang/mdBook/compare/6cbc41d...69a08ef)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Added ability to resize the sidebar.
|
- Added ability to resize the sidebar.
|
||||||
[#849](https://github.com/rust-lang-nursery/mdBook/pull/849)
|
[#849](https://github.com/rust-lang/mdBook/pull/849)
|
||||||
- Added `load_with_config_and_summary` function to `MDBook` to be able to
|
- Added `load_with_config_and_summary` function to `MDBook` to be able to
|
||||||
build a book with a custom `Summary`.
|
build a book with a custom `Summary`.
|
||||||
[#883](https://github.com/rust-lang-nursery/mdBook/pull/883)
|
[#883](https://github.com/rust-lang/mdBook/pull/883)
|
||||||
- Set `noindex` on `print.html` page to prevent robots from indexing it.
|
- Set `noindex` on `print.html` page to prevent robots from indexing it.
|
||||||
[#844](https://github.com/rust-lang-nursery/mdBook/pull/844)
|
[#844](https://github.com/rust-lang/mdBook/pull/844)
|
||||||
- Added support for ~~strikethrough~~ and GitHub-style tasklists.
|
- Added support for ~~strikethrough~~ and GitHub-style tasklists.
|
||||||
[#952](https://github.com/rust-lang-nursery/mdBook/pull/952)
|
[#952](https://github.com/rust-lang/mdBook/pull/952)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Command-line help output is now colored.
|
- Command-line help output is now colored.
|
||||||
[#861](https://github.com/rust-lang-nursery/mdBook/pull/861)
|
[#861](https://github.com/rust-lang/mdBook/pull/861)
|
||||||
- The build directory is now deleted before rendering starts, instead of after
|
- The build directory is now deleted before rendering starts, instead of after
|
||||||
if finishes.
|
if finishes.
|
||||||
[#878](https://github.com/rust-lang-nursery/mdBook/pull/878)
|
[#878](https://github.com/rust-lang/mdBook/pull/878)
|
||||||
- Removed dependency on `same-file` crate.
|
- Removed dependency on `same-file` crate.
|
||||||
[#903](https://github.com/rust-lang-nursery/mdBook/pull/903)
|
[#903](https://github.com/rust-lang/mdBook/pull/903)
|
||||||
- 💥 Renamed `with_preprecessor` to `with_preprocessor`.
|
- 💥 Renamed `with_preprecessor` to `with_preprocessor`.
|
||||||
[#906](https://github.com/rust-lang-nursery/mdBook/pull/906)
|
[#906](https://github.com/rust-lang/mdBook/pull/906)
|
||||||
- Updated ACE editor to 1.4.4, should remove a JavaScript console warning.
|
- Updated ACE editor to 1.4.4, should remove a JavaScript console warning.
|
||||||
[#935](https://github.com/rust-lang-nursery/mdBook/pull/935)
|
[#935](https://github.com/rust-lang/mdBook/pull/935)
|
||||||
- Dependencies have been updated.
|
- Dependencies have been updated.
|
||||||
[#934](https://github.com/rust-lang-nursery/mdBook/pull/934)
|
[#934](https://github.com/rust-lang/mdBook/pull/934)
|
||||||
[#945](https://github.com/rust-lang-nursery/mdBook/pull/945)
|
[#945](https://github.com/rust-lang/mdBook/pull/945)
|
||||||
- Highlight.js has been updated. This fixes some TOML highlighting, and adds
|
- Highlight.js has been updated. This fixes some TOML highlighting, and adds
|
||||||
Julia support.
|
Julia support.
|
||||||
[#942](https://github.com/rust-lang-nursery/mdBook/pull/942)
|
[#942](https://github.com/rust-lang/mdBook/pull/942)
|
||||||
- 🔥 Updated to pulldown-cmark 0.5. This may have significant changes to the
|
- 🔥 Updated to pulldown-cmark 0.5. This may have significant changes to the
|
||||||
formatting of existing books, as the newer version has more accurate
|
formatting of existing books, as the newer version has more accurate
|
||||||
interpretation of the CommonMark spec and a large number of bug fixes and
|
interpretation of the CommonMark spec and a large number of bug fixes and
|
||||||
changes.
|
changes.
|
||||||
[#898](https://github.com/rust-lang-nursery/mdBook/pull/898)
|
[#898](https://github.com/rust-lang/mdBook/pull/898)
|
||||||
- The `diff` language should now highlight correctly.
|
- The `diff` language should now highlight correctly.
|
||||||
[#943](https://github.com/rust-lang-nursery/mdBook/pull/943)
|
[#943](https://github.com/rust-lang/mdBook/pull/943)
|
||||||
- Make the blank region of a header not clickable.
|
- Make the blank region of a header not clickable.
|
||||||
[#948](https://github.com/rust-lang-nursery/mdBook/pull/948)
|
[#948](https://github.com/rust-lang/mdBook/pull/948)
|
||||||
- Rustdoc tests now use the preprocessed content instead of the raw,
|
- Rustdoc tests now use the preprocessed content instead of the raw,
|
||||||
unpreprocessed content.
|
unpreprocessed content.
|
||||||
[#891](https://github.com/rust-lang-nursery/mdBook/pull/891)
|
[#891](https://github.com/rust-lang/mdBook/pull/891)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fixed file change detection so that `mdbook serve` only reloads once when
|
- Fixed file change detection so that `mdbook serve` only reloads once when
|
||||||
multiple files are changed at once.
|
multiple files are changed at once.
|
||||||
[#870](https://github.com/rust-lang-nursery/mdBook/pull/870)
|
[#870](https://github.com/rust-lang/mdBook/pull/870)
|
||||||
- Fixed on-hover color highlighting for links in sidebar.
|
- Fixed on-hover color highlighting for links in sidebar.
|
||||||
[#834](https://github.com/rust-lang-nursery/mdBook/pull/834)
|
[#834](https://github.com/rust-lang/mdBook/pull/834)
|
||||||
- Fixed loss of focus when clicking the "Copy" button in code blocks.
|
- Fixed loss of focus when clicking the "Copy" button in code blocks.
|
||||||
[#867](https://github.com/rust-lang-nursery/mdBook/pull/867)
|
[#867](https://github.com/rust-lang/mdBook/pull/867)
|
||||||
- Fixed incorrectly stripping the path for `additional-js` files.
|
- Fixed incorrectly stripping the path for `additional-js` files.
|
||||||
[#796](https://github.com/rust-lang-nursery/mdBook/pull/796)
|
[#796](https://github.com/rust-lang/mdBook/pull/796)
|
||||||
- Fixed color of `code spans` that are links.
|
- Fixed color of `code spans` that are links.
|
||||||
[#905](https://github.com/rust-lang-nursery/mdBook/pull/905)
|
[#905](https://github.com/rust-lang/mdBook/pull/905)
|
||||||
- Fixed "next" navigation on index.html.
|
- Fixed "next" navigation on index.html.
|
||||||
[#916](https://github.com/rust-lang-nursery/mdBook/pull/916)
|
[#916](https://github.com/rust-lang/mdBook/pull/916)
|
||||||
- Fixed keyboard chapter navigation for `file` urls.
|
- Fixed keyboard chapter navigation for `file` urls.
|
||||||
[#915](https://github.com/rust-lang-nursery/mdBook/pull/915)
|
[#915](https://github.com/rust-lang/mdBook/pull/915)
|
||||||
- Fixed bad wrapping for inline code on some browsers.
|
- Fixed bad wrapping for inline code on some browsers.
|
||||||
[#818](https://github.com/rust-lang-nursery/mdBook/pull/818)
|
[#818](https://github.com/rust-lang/mdBook/pull/818)
|
||||||
- Properly load an existing `SUMMARY.md` in `mdbook init`.
|
- Properly load an existing `SUMMARY.md` in `mdbook init`.
|
||||||
[#841](https://github.com/rust-lang-nursery/mdBook/pull/841)
|
[#841](https://github.com/rust-lang/mdBook/pull/841)
|
||||||
- Fixed some broken links in `print.html`.
|
- Fixed some broken links in `print.html`.
|
||||||
[#871](https://github.com/rust-lang-nursery/mdBook/pull/871)
|
[#871](https://github.com/rust-lang/mdBook/pull/871)
|
||||||
- The Rust Playground link now supports the 2018 edition.
|
- The Rust Playground link now supports the 2018 edition.
|
||||||
[#946](https://github.com/rust-lang-nursery/mdBook/pull/946)
|
[#946](https://github.com/rust-lang/mdBook/pull/946)
|
||||||
|
|
||||||
## mdBook 0.2.3 (2018-01-18)
|
## mdBook 0.2.3 (2018-01-18)
|
||||||
[2c20c99...6cbc41d](https://github.com/rust-lang-nursery/mdBook/compare/2c20c99...6cbc41d)
|
[2c20c99...6cbc41d](https://github.com/rust-lang/mdBook/compare/2c20c99...6cbc41d)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Added an optional button to the top of the page which will link to a git
|
- 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
|
repository. Use the `git-repository-url` and `git-repository-icon` options
|
||||||
in the `[output.html]` section to enable it and set its appearance.
|
in the `[output.html]` section to enable it and set its appearance.
|
||||||
[#802](https://github.com/rust-lang-nursery/mdBook/pull/802)
|
[#802](https://github.com/rust-lang/mdBook/pull/802)
|
||||||
- Added a `default-theme` option to the `[output.html]` section.
|
- Added a `default-theme` option to the `[output.html]` section.
|
||||||
[#804](https://github.com/rust-lang-nursery/mdBook/pull/804)
|
[#804](https://github.com/rust-lang/mdBook/pull/804)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- 💥 Header ID anchors no longer add an arbitrary `a` character for headers
|
- 💥 Header ID anchors no longer add an arbitrary `a` character for headers
|
||||||
that start with a non-ascii-alphabetic character.
|
that start with a non-ascii-alphabetic character.
|
||||||
[#788](https://github.com/rust-lang-nursery/mdBook/pull/788)
|
[#788](https://github.com/rust-lang/mdBook/pull/788)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fix websocket hostname usage
|
- Fix websocket hostname usage
|
||||||
[#865](https://github.com/rust-lang-nursery/mdBook/pull/865)
|
[#865](https://github.com/rust-lang/mdBook/pull/865)
|
||||||
- Fixing links in print.html
|
- Fixing links in print.html
|
||||||
[#866](https://github.com/rust-lang-nursery/mdBook/pull/866)
|
[#866](https://github.com/rust-lang/mdBook/pull/866)
|
||||||
|
|
||||||
## mdBook 0.2.2 (2018-10-19)
|
## mdBook 0.2.2 (2018-10-19)
|
||||||
[7e2e095...2c20c99](https://github.com/rust-lang-nursery/mdBook/compare/7e2e095...2c20c99)
|
[7e2e095...2c20c99](https://github.com/rust-lang/mdBook/compare/7e2e095...2c20c99)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- 🎉 Process-based custom preprocessors. See [the
|
- 🎉 Process-based custom preprocessors. See [the
|
||||||
docs](https://rust-lang-nursery.github.io/mdBook/for_developers/preprocessors.html)
|
docs](https://rust-lang.github.io/mdBook/for_developers/preprocessors.html)
|
||||||
for more.
|
for more.
|
||||||
[#792](https://github.com/rust-lang-nursery/mdBook/pull/792)
|
[#792](https://github.com/rust-lang/mdBook/pull/792)
|
||||||
|
|
||||||
- 🎉 Configurable preprocessors.
|
- 🎉 Configurable preprocessors.
|
||||||
|
|
||||||
|
@ -230,26 +230,26 @@
|
||||||
|
|
||||||
Added `PreprocessorContext::renderer` to indicate the renderer being used.
|
Added `PreprocessorContext::renderer` to indicate the renderer being used.
|
||||||
|
|
||||||
[#658](https://github.com/rust-lang-nursery/mdBook/pull/658)
|
[#658](https://github.com/rust-lang/mdBook/pull/658)
|
||||||
[#787](https://github.com/rust-lang-nursery/mdBook/pull/787)
|
[#787](https://github.com/rust-lang/mdBook/pull/787)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fix paths to additional CSS and JavaScript files
|
- Fix paths to additional CSS and JavaScript files
|
||||||
[#777](https://github.com/rust-lang-nursery/mdBook/pull/777)
|
[#777](https://github.com/rust-lang/mdBook/pull/777)
|
||||||
- Ensure section numbers are correctly incremented after a horizontal
|
- Ensure section numbers are correctly incremented after a horizontal
|
||||||
separator
|
separator
|
||||||
[#790](https://github.com/rust-lang-nursery/mdBook/pull/790)
|
[#790](https://github.com/rust-lang/mdBook/pull/790)
|
||||||
|
|
||||||
## mdBook 0.2.1 (2018-08-22)
|
## mdBook 0.2.1 (2018-08-22)
|
||||||
[91ffca1...7e2e095](https://github.com/rust-lang-nursery/mdBook/compare/91ffca1...7e2e095)
|
[91ffca1...7e2e095](https://github.com/rust-lang/mdBook/compare/91ffca1...7e2e095)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Update to handlebars-rs 1.0
|
- Update to handlebars-rs 1.0
|
||||||
[#761](https://github.com/rust-lang-nursery/mdBook/pull/761)
|
[#761](https://github.com/rust-lang/mdBook/pull/761)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fix table colors, broken by Stylus -> CSS transition
|
- Fix table colors, broken by Stylus -> CSS transition
|
||||||
[#765](https://github.com/rust-lang-nursery/mdBook/pull/765)
|
[#765](https://github.com/rust-lang/mdBook/pull/765)
|
||||||
|
|
||||||
## mdBook 0.2.0 (2018-08-02)
|
## mdBook 0.2.0 (2018-08-02)
|
||||||
|
|
||||||
|
@ -257,7 +257,7 @@
|
||||||
- 💥 This release changes how links are handled in mdBook. Previously, relative
|
- 💥 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
|
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
|
relative to the page they are in, and use the `.md` extension. This has [several
|
||||||
advantages](https://github.com/rust-lang-nursery/mdBook/pull/603#issue-166701447),
|
advantages](https://github.com/rust-lang/mdBook/pull/603#issue-166701447),
|
||||||
such as making links work in other markdown viewers like GitHub. You will
|
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
|
likely have to change links in your book to accommodate this change. For
|
||||||
example, a book with this layout:
|
example, a book with this layout:
|
||||||
|
@ -289,11 +289,11 @@
|
||||||
help serve` for details.
|
help serve` for details.
|
||||||
|
|
||||||
- Embedded rust playpens now use the "stable" playground API.
|
- Embedded rust playpens now use the "stable" playground API.
|
||||||
[#754](https://github.com/rust-lang-nursery/mdBook/pull/754)
|
[#754](https://github.com/rust-lang/mdBook/pull/754)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Escaped includes (`\{{#include file.rs}}`) will now render correctly.
|
- Escaped includes (`\{{#include file.rs}}`) will now render correctly.
|
||||||
[f30ce01](https://github.com/rust-lang-nursery/mdBook/commit/f30ce0184d71e342141145472bf816419d30a2c5)
|
[f30ce01](https://github.com/rust-lang/mdBook/commit/f30ce0184d71e342141145472bf816419d30a2c5)
|
||||||
- `index.html` will now render correctly when the book's first section is
|
- `index.html` will now render correctly when the book's first section is
|
||||||
inside a subdirectory.
|
inside a subdirectory.
|
||||||
[#756](https://github.com/rust-lang-nursery/mdBook/pull/756)
|
[#756](https://github.com/rust-lang/mdBook/pull/756)
|
||||||
|
|
|
@ -5,22 +5,22 @@ Welcome stranger!
|
||||||
If you have come here to learn how to contribute to mdBook, we have some tips for you!
|
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!
|
First of all, don't hesitate to ask questions!
|
||||||
Use the [issue tracker](https://github.com/rust-lang-nursery/mdBook/issues), no question is too simple.
|
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:
|
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
|
### Issues to work on
|
||||||
|
|
||||||
Any issue is up for the grabbing, but if you are starting out, you might be interested in the
|
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-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy).
|
[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.
|
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
|
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.
|
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
|
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-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
|
[A-JavaScript](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-JavaScript),
|
||||||
[A-Style](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
|
[A-Style](https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Style),
|
||||||
[A-HTML](https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-HTML) or
|
[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-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AA-Mobile).
|
[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.
|
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.
|
Again, do not hesitate to ask questions. We will gladly mentor anyone that want to tackle an issue.
|
||||||
|
@ -41,7 +41,7 @@ mdBook builds on stable Rust, if you want to build mdBook from source, here are
|
||||||
0. Clone this repository with git.
|
0. Clone this repository with git.
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/rust-lang-nursery/mdBook.git
|
git clone https://github.com/rust-lang/mdBook.git
|
||||||
```
|
```
|
||||||
0. Navigate into the newly created `mdBook` directory
|
0. Navigate into the newly created `mdBook` directory
|
||||||
0. Run `cargo build`
|
0. Run `cargo build`
|
||||||
|
@ -57,7 +57,7 @@ We love code quality and Rust has some excellent tools to assist you with contri
|
||||||
Before you make your Pull Request to the project, please run it through the `rustfmt` utility.
|
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.
|
This will ensure we have good quality source code that is better for us all to maintain.
|
||||||
|
|
||||||
[rustfmt](https://github.com/rust-lang-nursery/rustfmt) has a lot more information on the project.
|
[rustfmt](https://github.com/rust-lang/rustfmt) has a lot more information on the project.
|
||||||
The quick guide is
|
The quick guide is
|
||||||
|
|
||||||
1. Install it
|
1. Install it
|
||||||
|
@ -74,7 +74,7 @@ The quick guide is
|
||||||
```
|
```
|
||||||
When run through `cargo` it will format all bin and lib files in the current crate.
|
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-nursery/rustfmt)
|
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
|
#### Finding Issues with Clippy
|
||||||
|
@ -83,7 +83,7 @@ Clippy is a code analyser/linter detecting mistakes, and therfore helps to impro
|
||||||
Like formatting your code with `rustfmt`, running clippy regularly and before your Pull Request will
|
Like formatting your code with `rustfmt`, running clippy regularly and before your Pull Request will
|
||||||
help us maintain awesome code.
|
help us maintain awesome code.
|
||||||
|
|
||||||
The best documentation can be found over at [rust-clippy](https://github.com/rust-lang-nursery/rust-clippy)
|
The best documentation can be found over at [rust-clippy](https://github.com/rust-lang/rust-clippy)
|
||||||
|
|
||||||
1. To install
|
1. To install
|
||||||
```
|
```
|
||||||
|
@ -94,7 +94,7 @@ The best documentation can be found over at [rust-clippy](https://github.com/rus
|
||||||
cargo clippy
|
cargo clippy
|
||||||
```
|
```
|
||||||
|
|
||||||
Clippy has an ever growing list of checks, that are managed in [lint files](https://rust-lang-nursery.github.io/rust-clippy/master/index.html).
|
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
|
### Making a pull-request
|
||||||
|
|
||||||
|
@ -102,7 +102,7 @@ When you feel comfortable that your changes could be integrated into mdBook, you
|
||||||
One of the core maintainers will then approve the changes or request some changes before it gets merged.
|
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)
|
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-nursery/rustfmt) on the code first.
|
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.
|
This is not a requirement though and will never block a pull-request from being merged.
|
||||||
|
|
||||||
That's it, happy contributions! :tada: :tada: :tada:
|
That's it, happy contributions! :tada: :tada: :tada:
|
||||||
|
|
|
@ -6,13 +6,13 @@ authors = [
|
||||||
"Michael-F-Bryan <michaelfbryan@gmail.com>",
|
"Michael-F-Bryan <michaelfbryan@gmail.com>",
|
||||||
"Matt Ickstadt <mattico8@gmail.com>"
|
"Matt Ickstadt <mattico8@gmail.com>"
|
||||||
]
|
]
|
||||||
documentation = "http://rust-lang-nursery.github.io/mdBook/index.html"
|
documentation = "http://rust-lang.github.io/mdBook/index.html"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
exclude = ["/book-example/*"]
|
exclude = ["/book-example/*"]
|
||||||
keywords = ["book", "gitbook", "rustbook", "markdown"]
|
keywords = ["book", "gitbook", "rustbook", "markdown"]
|
||||||
license = "MPL-2.0"
|
license = "MPL-2.0"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
repository = "https://github.com/rust-lang-nursery/mdBook"
|
repository = "https://github.com/rust-lang/mdBook"
|
||||||
description = "Creates a book from markdown files"
|
description = "Creates a book from markdown files"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
|
22
README.md
22
README.md
|
@ -1,8 +1,8 @@
|
||||||
# mdBook
|
# mdBook
|
||||||
|
|
||||||
[![Build Status](https://github.com/rust-lang-nursery/mdBook/workflows/CI/badge.svg)](https://github.com/rust-lang-nursery/mdBook/actions?workflow=CI)
|
[![Build Status](https://github.com/rust-lang/mdBook/workflows/CI/badge.svg)](https://github.com/rust-lang/mdBook/actions?workflow=CI)
|
||||||
[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook)
|
[![crates.io](https://img.shields.io/crates/v/mdbook.svg)](https://crates.io/crates/mdbook)
|
||||||
[![LICENSE](https://img.shields.io/github/license/rust-lang-nursery/mdBook.svg)](LICENSE)
|
[![LICENSE](https://img.shields.io/github/license/rust-lang/mdBook.svg)](LICENSE)
|
||||||
|
|
||||||
mdBook is a utility to create modern online books from Markdown files.
|
mdBook is a utility to create modern online books from Markdown files.
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ There are multiple ways to install mdBook.
|
||||||
the git version of mdBook yourself. Cargo makes this ***super easy***!
|
the git version of mdBook yourself. Cargo makes this ***super easy***!
|
||||||
|
|
||||||
```
|
```
|
||||||
cargo install --git https://github.com/rust-lang-nursery/mdBook.git mdbook
|
cargo install --git https://github.com/rust-lang/mdBook.git mdbook
|
||||||
```
|
```
|
||||||
|
|
||||||
Again, make sure to add the Cargo bin directory to your `PATH`.
|
Again, make sure to add the Cargo bin directory to your `PATH`.
|
||||||
|
@ -66,7 +66,7 @@ There are multiple ways to install mdBook.
|
||||||
your local machine:
|
your local machine:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://github.com/rust-lang-nursery/mdBook.git
|
git clone https://github.com/rust-lang/mdBook.git
|
||||||
```
|
```
|
||||||
|
|
||||||
`cd` into `mdBook/` and run
|
`cd` into `mdBook/` and run
|
||||||
|
@ -217,14 +217,14 @@ available, for those hacking on `master`.
|
||||||
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.
|
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-nursery.github.io/mdBook/
|
[User Guide]: https://rust-lang.github.io/mdBook/
|
||||||
[API docs]: https://docs.rs/mdbook/*/mdbook/
|
[API docs]: https://docs.rs/mdbook/*/mdbook/
|
||||||
[E-Easy]: https://github.com/rust-lang-nursery/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy
|
[E-Easy]: https://github.com/rust-lang/mdBook/issues?q=is%3Aopen+is%3Aissue+label%3AE-Easy
|
||||||
[contribution guide]: https://github.com/rust-lang-nursery/mdBook/blob/master/CONTRIBUTING.md
|
[contribution guide]: https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md
|
||||||
[LICENSE]: https://github.com/rust-lang-nursery/mdBook/blob/master/LICENSE
|
[LICENSE]: https://github.com/rust-lang/mdBook/blob/master/LICENSE
|
||||||
[releases]: https://github.com/rust-lang-nursery/mdBook/releases
|
[releases]: https://github.com/rust-lang/mdBook/releases
|
||||||
[Rust]: https://www.rust-lang.org/
|
[Rust]: https://www.rust-lang.org/
|
||||||
[CLI docs]: http://rust-lang-nursery.github.io/mdBook/cli/init.html
|
[CLI docs]: http://rust-lang.github.io/mdBook/cli/init.html
|
||||||
[master-docs]: http://rust-lang-nursery.github.io/mdBook/
|
[master-docs]: http://rust-lang.github.io/mdBook/
|
||||||
[`linkcheck`]: https://crates.io/crates/mdbook-linkcheck
|
[`linkcheck`]: https://crates.io/crates/mdbook-linkcheck
|
||||||
[`epub`]: https://crates.io/crates/mdbook-epub
|
[`epub`]: https://crates.io/crates/mdbook-epub
|
||||||
|
|
|
@ -8,9 +8,9 @@ What you are reading serves as an example of the output of mdBook and at the
|
||||||
same time as a high-level documentation.
|
same time as a high-level documentation.
|
||||||
|
|
||||||
mdBook is free and open source, you can find the source code on
|
mdBook is free and open source, you can find the source code on
|
||||||
[GitHub](https://github.com/rust-lang-nursery/mdBook). Issues and feature
|
[GitHub](https://github.com/rust-lang/mdBook). Issues and feature
|
||||||
requests can be posted on the [GitHub issue
|
requests can be posted on the [GitHub issue
|
||||||
tracker](https://github.com/rust-lang-nursery/mdBook/issues).
|
tracker](https://github.com/rust-lang/mdBook/issues).
|
||||||
|
|
||||||
## API docs
|
## API docs
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@ capabilities first.
|
||||||
## Install From Binaries
|
## Install From Binaries
|
||||||
|
|
||||||
Precompiled binaries are provided for major platforms on a best-effort basis.
|
Precompiled binaries are provided for major platforms on a best-effort basis.
|
||||||
Visit [the releases page](https://github.com/rust-lang-nursery/mdBook/releases)
|
Visit [the releases page](https://github.com/rust-lang/mdBook/releases)
|
||||||
to download the appropriate version for your platform.
|
to download the appropriate version for your platform.
|
||||||
|
|
||||||
## Install From Source
|
## Install From Source
|
||||||
|
@ -39,14 +39,14 @@ have installed mdBook!
|
||||||
|
|
||||||
### Install Git version
|
### Install Git version
|
||||||
|
|
||||||
The **[git version](https://github.com/rust-lang-nursery/mdBook)** contains all
|
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
|
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
|
**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
|
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.
|
choice. We need to clone the git repository and then build it with Cargo.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone --depth=1 https://github.com/rust-lang-nursery/mdBook.git
|
git clone --depth=1 https://github.com/rust-lang/mdBook.git
|
||||||
cd mdBook
|
cd mdBook
|
||||||
cargo build --release
|
cargo build --release
|
||||||
```
|
```
|
||||||
|
|
|
@ -352,4 +352,4 @@ the source code or ask questions.
|
||||||
[`Book`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html
|
[`Book`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html
|
||||||
[`Book::iter()`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html#method.iter
|
[`Book::iter()`]: https://docs.rs/mdbook/*/mdbook/book/struct.Book.html#method.iter
|
||||||
[`Config`]: https://docs.rs/mdbook/*/mdbook/config/struct.Config.html
|
[`Config`]: https://docs.rs/mdbook/*/mdbook/config/struct.Config.html
|
||||||
[issue tracker]: https://github.com/rust-lang-nursery/mdBook/issues
|
[issue tracker]: https://github.com/rust-lang/mdBook/issues
|
||||||
|
|
|
@ -109,7 +109,7 @@ For everything else, have a look [at the complete example][example].
|
||||||
[preprocessor-docs]: https://docs.rs/mdbook/latest/mdbook/preprocess/trait.Preprocessor.html
|
[preprocessor-docs]: https://docs.rs/mdbook/latest/mdbook/preprocess/trait.Preprocessor.html
|
||||||
[pc]: https://crates.io/crates/pulldown-cmark
|
[pc]: https://crates.io/crates/pulldown-cmark
|
||||||
[pctc]: https://crates.io/crates/pulldown-cmark-to-cmark
|
[pctc]: https://crates.io/crates/pulldown-cmark-to-cmark
|
||||||
[example]: https://github.com/rust-lang-nursery/mdBook/blob/master/examples/nop-preprocessor.rs
|
[example]: https://github.com/rust-lang/mdBook/blob/master/examples/nop-preprocessor.rs
|
||||||
[an example no-op preprocessor]: https://github.com/rust-lang-nursery/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
|
[`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
|
[`Book::for_each_mut()`]: https://docs.rs/mdbook/latest/mdbook/book/struct.Book.html#method.for_each_mut
|
||||||
|
|
|
@ -237,7 +237,7 @@ google-analytics = "123456"
|
||||||
additional-css = ["custom.css", "custom2.css"]
|
additional-css = ["custom.css", "custom2.css"]
|
||||||
additional-js = ["custom.js"]
|
additional-js = ["custom.js"]
|
||||||
no-section-label = false
|
no-section-label = false
|
||||||
git-repository-url = "https://github.com/rust-lang-nursery/mdBook"
|
git-repository-url = "https://github.com/rust-lang/mdBook"
|
||||||
git-repository-icon = "fa-github"
|
git-repository-icon = "fa-github"
|
||||||
|
|
||||||
[output.html.fold]
|
[output.html.fold]
|
||||||
|
|
|
@ -97,4 +97,4 @@ Of course the inner html can be changed to your liking.
|
||||||
------
|
------
|
||||||
|
|
||||||
*If you would like other properties or helpers exposed, please [create a new
|
*If you would like other properties or helpers exposed, please [create a new
|
||||||
issue](https://github.com/rust-lang-nursery/mdBook/issues)*
|
issue](https://github.com/rust-lang/mdBook/issues)*
|
||||||
|
|
|
@ -62,7 +62,7 @@ everyone can benefit from it.**
|
||||||
|
|
||||||
If you think the default theme doesn't look quite right for a specific language,
|
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
|
or could be improved. Feel free to [submit a new
|
||||||
issue](https://github.com/rust-lang-nursery/mdBook/issues) explaining what you
|
issue](https://github.com/rust-lang/mdBook/issues) explaining what you
|
||||||
have in mind and I will take a look at it.
|
have in mind and I will take a look at it.
|
||||||
|
|
||||||
You could also create a pull-request with the proposed improvements.
|
You could also create a pull-request with the proposed improvements.
|
||||||
|
|
|
@ -56,7 +56,7 @@ impl MDBook {
|
||||||
warn!("This format is no longer used, so you should migrate to the");
|
warn!("This format is no longer used, so you should migrate to the");
|
||||||
warn!("book.toml format.");
|
warn!("book.toml format.");
|
||||||
warn!("Check the user guide for migration information:");
|
warn!("Check the user guide for migration information:");
|
||||||
warn!("\thttps://rust-lang-nursery.github.io/mdBook/format/config.html");
|
warn!("\thttps://rust-lang.github.io/mdBook/format/config.html");
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut config = if config_location.exists() {
|
let mut config = if config_location.exists() {
|
||||||
|
|
|
@ -728,7 +728,7 @@ mod tests {
|
||||||
assert!(got.is_err());
|
assert!(got.is_err());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Regression test for https://github.com/rust-lang-nursery/mdBook/issues/779
|
/// Regression test for https://github.com/rust-lang/mdBook/issues/779
|
||||||
/// Ensure section numbers are correctly incremented after a horizontal separator.
|
/// Ensure section numbers are correctly incremented after a horizontal separator.
|
||||||
#[test]
|
#[test]
|
||||||
fn keep_numbering_after_separator() {
|
fn keep_numbering_after_separator() {
|
||||||
|
|
|
@ -59,7 +59,7 @@ fn remove_ignored_files(book_root: &PathBuf, paths: &[PathBuf]) -> Vec<PathBuf>
|
||||||
Ok(exclusion_checker) => filter_ignored_files(exclusion_checker, paths),
|
Ok(exclusion_checker) => filter_ignored_files(exclusion_checker, paths),
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
// We're unable to read the .gitignore file, so we'll silently allow everything.
|
// We're unable to read the .gitignore file, so we'll silently allow everything.
|
||||||
// Please see discussion: https://github.com/rust-lang-nursery/mdBook/pull/1051
|
// Please see discussion: https://github.com/rust-lang/mdBook/pull/1051
|
||||||
paths.iter().map(|path| path.to_path_buf()).collect()
|
paths.iter().map(|path| path.to_path_buf()).collect()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -296,7 +296,7 @@ impl<'de> Deserialize<'de> for Config {
|
||||||
warn!("`description` under a table called `[book]`, move the `destination` entry");
|
warn!("`description` under a table called `[book]`, move the `destination` entry");
|
||||||
warn!("from `[output.html]`, renamed to `build-dir`, under a table called");
|
warn!("from `[output.html]`, renamed to `build-dir`, under a table called");
|
||||||
warn!("`[build]`, and it should all work.");
|
warn!("`[build]`, and it should all work.");
|
||||||
warn!("Documentation: http://rust-lang-nursery.github.io/mdBook/format/config.html");
|
warn!("Documentation: http://rust-lang.github.io/mdBook/format/config.html");
|
||||||
return Ok(Config::from_legacy(raw));
|
return Ok(Config::from_legacy(raw));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -75,9 +75,9 @@
|
||||||
//! directly, making deserializing the `RenderContext` easy and giving you
|
//! directly, making deserializing the `RenderContext` easy and giving you
|
||||||
//! access to the various methods for working with the [`Config`].
|
//! access to the various methods for working with the [`Config`].
|
||||||
//!
|
//!
|
||||||
//! [user guide]: https://rust-lang-nursery.github.io/mdBook/
|
//! [user guide]: https://rust-lang.github.io/mdBook/
|
||||||
//! [`RenderContext`]: renderer/struct.RenderContext.html
|
//! [`RenderContext`]: renderer/struct.RenderContext.html
|
||||||
//! [relevant chapter]: https://rust-lang-nursery.github.io/mdBook/for_developers/backends.html
|
//! [relevant chapter]: https://rust-lang.github.io/mdBook/for_developers/backends.html
|
||||||
//! [`Config`]: config/struct.Config.html
|
//! [`Config`]: config/struct.Config.html
|
||||||
|
|
||||||
#![deny(missing_docs)]
|
#![deny(missing_docs)]
|
||||||
|
|
|
@ -30,7 +30,7 @@ fn main() {
|
||||||
.setting(AppSettings::ColoredHelp)
|
.setting(AppSettings::ColoredHelp)
|
||||||
.after_help(
|
.after_help(
|
||||||
"For more information about a specific command, try `mdbook <command> --help`\n\
|
"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-nursery/mdBook",
|
The source code for mdBook is available at: https://github.com/rust-lang/mdBook",
|
||||||
)
|
)
|
||||||
.subcommand(cmd::init::make_subcommand())
|
.subcommand(cmd::init::make_subcommand())
|
||||||
.subcommand(cmd::build::make_subcommand())
|
.subcommand(cmd::build::make_subcommand())
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
//!
|
//!
|
||||||
//! The definition for [RenderContext] may be useful though.
|
//! The definition for [RenderContext] may be useful though.
|
||||||
//!
|
//!
|
||||||
//! [For Developers]: https://rust-lang-nursery.github.io/mdBook/for_developers/index.html
|
//! [For Developers]: https://rust-lang.github.io/mdBook/for_developers/index.html
|
||||||
//! [RenderContext]: struct.RenderContext.html
|
//! [RenderContext]: struct.RenderContext.html
|
||||||
|
|
||||||
pub use self::html_handlebars::HtmlHandlebars;
|
pub use self::html_handlebars::HtmlHandlebars;
|
||||||
|
|
|
@ -366,7 +366,7 @@ function playpen_text(playpen) {
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang-nursery/mdBook/issues/628
|
// Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
|
||||||
document.addEventListener('click', function(e) {
|
document.addEventListener('click', function(e) {
|
||||||
if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
|
if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
|
||||||
hideThemes();
|
hideThemes();
|
||||||
|
|
|
@ -37,8 +37,8 @@ pub fn write_file<P: AsRef<Path>>(build_dir: &Path, filename: P, content: &[u8])
|
||||||
///
|
///
|
||||||
/// **note:** it's not very fool-proof, if you find a situation where
|
/// **note:** it's not very fool-proof, if you find a situation where
|
||||||
/// it doesn't return the correct path.
|
/// it doesn't return the correct path.
|
||||||
/// Consider [submitting a new issue](https://github.com/rust-lang-nursery/mdBook/issues)
|
/// Consider [submitting a new issue](https://github.com/rust-lang/mdBook/issues)
|
||||||
/// or a [pull-request](https://github.com/rust-lang-nursery/mdBook/pulls) to improve it.
|
/// or a [pull-request](https://github.com/rust-lang/mdBook/pulls) to improve it.
|
||||||
pub fn path_to_root<P: Into<PathBuf>>(path: P) -> String {
|
pub fn path_to_root<P: Into<PathBuf>>(path: P) -> String {
|
||||||
debug!("path_to_root");
|
debug!("path_to_root");
|
||||||
// Remove filename and add "../" for every directory
|
// Remove filename and add "../" for every directory
|
||||||
|
|
Loading…
Reference in New Issue