e3ec751a3f
Issue 703 ( #929 )
...
* Replace all occurances of altenate backend with alternative backed
Rename test for consistency of the terminology.
* Use better sed command
2019-05-19 22:16:10 +02:00
fc565df86b
Some documentation fixes. ( #925 )
2019-05-19 00:05:57 +02:00
df12cc55c8
Revert "Merge pull request #889 from s3bk/master" ( #917 )
...
* Revert "Merge pull request #889 from s3bk/master"
This reverts commit b30b58b565c6220fba83
2019-05-09 20:18:28 +02:00
cb4a3e0711
Fix more print.html links. ( #871 )
2019-05-08 23:50:59 +02:00
506996808b
Fix issue 832 ( #841 )
...
* Add if around stub summary creation
Check if an existing SUMMARY.md is present to prevent overwriting it
with the stub SUMMARY.md.
[#832 ]
* Add test for existing SUMMARY.md
2019-05-08 21:13:20 +02:00
5163c5ab75
Don't let robots index the print.html ( #844 )
2019-05-08 00:32:43 +02:00
ecfaed1e02
Change overflow-x to initial ( #818 )
...
Change overflow-x from auto to initial.
This resolves weird rendering behavior in Chrome and Safari on macOS.
With help from @bash
Co-authored-by: Ruben Schmidmeister <ruben.schmidmeister@icloud.com>
2019-05-08 00:30:28 +02:00
8bb5426441
Fix keyboard chapter navigation for `file` urls. ( #915 )
2019-05-08 00:29:46 +02:00
a674c9eff1
Fix "next" navigation on index.html. ( #916 )
2019-05-08 00:27:48 +02:00
581187098c
Deny 2018 edition idioms globally ( #911 )
2019-05-06 22:50:34 +02:00
ab7802a9a9
Fix most of clippy warnings ( #914 )
...
* Fix clippy: cast_lossless
* Fix clippy: match_ref_pats
* Fix clippy: extra_unused_lifetimes
* Fix clippy: needless_lifetimes
* Fix clippy: new_without_default
* Fix clippy: or_fun_call
* Fix clippy: should_implement_trait
* Fix clippy: redundant_closure
* Fix clippy: const_static_lifetime
* Fix clippy: redundant_pattern_matching
* Fix clippy: unused_io_amount
* Fix clippy: string_lit_as_bytes
* Fix clippy: needless_update
* Fix clippy: blacklisted_name
* Fix clippy: collapsible_if
* Fix clippy: match_wild_err_arm
* Fix clippy: single_match
* Fix clippy: useless_vec
* Fix clippy: single_char_pattern
* Fix clippy: float_cmp
* Fix clippy: approx_constant
2019-05-06 20:20:58 +02:00
0aa3a9045a
cargo fmt
2019-05-05 22:00:24 +07:00
b30b58b565
Merge pull request #889 from s3bk/master
...
new "Book" theme
2019-05-04 17:45:37 +02:00
7e26a8430d
Update mod.rs
2019-05-03 19:59:58 +02:00
dd69e03ff5
Fix color of `code spans` that are links.
2019-05-02 11:07:24 -07:00
f01fe854fa
Merge pull request #883 from anp/custom_summary
...
Expose API for building a book with a custom Summary.
2019-04-30 00:25:03 +02:00
6eeaaaa44d
Merge pull request #819 from StefanieJaeger/css-comment
...
Update comment in editor.js
2019-04-28 23:56:13 +02:00
357ebcf7ce
Merge pull request #849 from gentoo90/sidebar-resize
...
Add sidebar resize
2019-04-28 23:29:07 +02:00
9712347b9c
Merge pull request #796 from badboy/dont-trim-external-js-path
...
Don't strip relative path of additional javascript files
2019-04-26 09:01:39 +02:00
f73d42d994
Merge pull request #878 from shen390s/master
...
Cleanup build directory before preprocessors run to keep files genera…
2019-04-26 00:17:09 +02:00
a647017e4b
Merge pull request #861 from k-nasa/add_colored_help
...
Add colored help
2019-04-25 23:19:18 +02:00
99dc62f9c3
Merge pull request #867 from ffissore/master
...
Fixed loss of focus when clicking the Copy button
2019-04-23 20:25:58 +02:00
b891fd5a12
Merge pull request #834 from donald-pinckney/master
...
Fixes #826
2019-04-23 11:36:43 +02:00
02fa7b0a11
When the Copy button is pressed, focus is lost and scrolling the page
...
with the arrow keys stops working. Fixed by upgrading ClipboardJS to
the latest version
2019-04-23 09:29:22 +02:00
8b2e1c2daa
Merge pull request #870 from cauebs/group-events
...
Group file changes and rebuild book only once
2019-04-23 00:20:54 +02:00
88d2f69138
Merge pull request #860 from k-nasa/fix_duplication
...
Fix duplication with Cargo.toml
2019-04-22 12:31:50 +02:00
0dc2728fa9
Merge branch 'master' of github.com:rust-lang-nursery/mdBook
2019-04-18 12:29:32 -04:00
4abac12c04
Fix deprecation warnings for trim left/right matches
2019-03-23 08:47:10 -04:00
d7c7d91005
Write preprocessed content to file before testing with rustdoc
...
Fixes #855 .
2019-03-23 08:35:44 -04:00
9243cf9d95
well. typo
2019-03-21 07:56:48 +01:00
d2470730fc
center book title
2019-03-20 22:13:12 +01:00
6a2e2461fb
quote inline code
2019-03-20 17:02:05 +01:00
3faa3e42f0
switch to Source font family
2019-03-20 16:34:19 +01:00
9c8fae4704
fix forgotten rename
2019-03-20 15:36:40 +01:00
9b6f5a9840
add Book theme (Liberation fonts need to be in /fonts/ on the server)
2019-03-20 15:21:36 +01:00
37808b7e08
Expose API for building a book with a custom Summary.
...
This is useful for situations where you'd like to
supplement or replace the existing Summary parsing with
custom filesystem traversal code or other similar changes.
2019-03-04 11:44:00 -08:00
b37f21a09b
Cleanup build directory before preprocessors run to keep files generated by preprocessors
2019-02-16 12:17:26 +08:00
c7281459f9
Group file changes and rebuild book only once
2019-01-31 16:31:02 -02:00
25c1ca1275
Merge pull request #866 from rust-lang-nursery/gh828
...
Fixing links in print.html
2019-01-18 09:54:17 -05:00
23ac06e2eb
Fix a bug in link re-writing
...
In a regex, `.` means `[0-9a-zA-Z]`, not a period character. This means
that this regex worked, unless a link anchor contained `md` inside of
it. This fixes the regex to match a literal period.
Reported by @ehuss in
https://github.com/rust-lang-nursery/mdBook/pull/866#issuecomment-454595806
2019-01-16 15:44:51 -05:00
2ddbb37f49
Fix the bug
2019-01-15 14:10:02 -05:00
954cfa86e5
Fix websocket hostname usage
...
The livereload url was using an unknown property "websocket-address" instead of "websocket-hostname", hence it was always fallback onto the hostname (which can be different).
2019-01-09 17:59:45 +01:00
7e52da3c1b
Add colored help
2018-12-25 21:35:37 +09:00
78ee8e43bb
Fix duplication with Cargo.toml
2018-12-25 21:10:07 +09:00
3d8db7f25c
Disable text selection and CSS transition while resizing sidebar
2018-12-12 21:55:50 +02:00
3d37e24c14
Add sidebar resizing
2018-12-12 21:55:50 +02:00
742dbbc917
Run rustfmt.
2018-12-04 00:11:41 +01:00
991a725c26
Solve the simplest clippy warnings and run rustfmt
2018-12-04 00:10:09 +01:00
317c7731da
Remove extra comment
2018-11-28 20:07:37 -05:00
4c17b11ed0
Fix #826
2018-11-28 20:05:37 -05:00
8c86031384
Fix invalid url in renderer documentation
2018-11-21 08:59:53 +08:00
5151aae07e
Update comment
...
Comment in editor.js referenced file called "general.styl", changed that
to "general.css".
2018-11-09 17:34:57 +01:00
42b87e0fbc
Merge pull request #804 from Bassetts/default-theme-option
...
Default theme option
2018-10-30 21:18:48 +08:00
33add4b532
Merge pull request #782 from mattico/document-dest-dir-rel
...
Document dest-dir relative path behavior
2018-10-23 12:16:37 -05:00
b0513ee771
Merge pull request #788 from weihanglo/feat/non-ascii-heading-anchor
...
Allow non alphabetic initial in heading anchor
2018-10-23 19:21:44 +08:00
b4538da9c3
Merge pull request #802 from Bassetts/git-button
...
Implement a git repository button
2018-10-23 19:16:45 +08:00
13a9aab2b2
Improve documentation comments
2018-10-23 10:34:14 +09:00
f6a7432569
Added a round-trip test to make sure parse_input() is always correct
2018-10-20 12:50:35 +08:00
89ea60e7a5
Made __non_exhaustive fields #[serde(skip)]
2018-10-20 11:21:24 +08:00
10b69e60c8
Add documentation and tests
2018-10-15 21:40:59 +01:00
336e08fe50
Update FontAwesome version to 4.7.0
2018-10-15 20:01:36 +01:00
5bfdf9fcc8
Added git-repository-icon option
...
Updated documentation and added tests.
2018-10-15 19:48:54 +01:00
29f8b791f1
Merge pull request #792 from rust-lang-nursery/custom-preprocessor
...
WIP: Custom Preprocessors
2018-10-16 00:02:12 +08:00
d2565af000
Add helper to format theme name for theme changer
2018-10-13 14:44:10 +01:00
599e47f1f1
Initial implementation of a git repository button
2018-10-13 12:17:33 +01:00
0c31ab2953
Initial implementation of default theme option
2018-10-12 19:57:59 +01:00
b1c7c54108
Rewrote a large proportion of the Preprocessor docs to be up-to-date
2018-09-25 19:48:20 +08:00
f654c42426
Don't strip relative path of additional javascript files
...
Previously, additional JavaScript files inside a directory were
correctly copied (with their parent created), but the link to it was
stripped of that parent.
There's no need for that (and it was not done for CSS)
2018-09-19 20:36:32 +02:00
0c926b3e88
Ensure section numbers are correctly incremented after a horizontal separator ( #790 )
...
Fixes #779
2018-09-19 23:33:28 +08:00
adec78e7f5
Forgot to implement 3rd party preprocessor discovery
2018-09-19 23:16:11 +08:00
5cd5e4764c
Fleshed out the api docs
2018-09-16 23:44:52 +08:00
1d72cea972
The example preprocessor works
2018-09-16 23:28:01 +08:00
1aa1194d79
We can shell out to the preprocessor
2018-09-16 23:23:03 +08:00
304234c122
The example can now tell mdbook if renderers are supported
2018-09-16 23:00:19 +08:00
729c94a7e4
Started working on a custom preprocessor
2018-09-16 22:49:52 +08:00
5dce539928
Notify preprocessors of the mdbook version and add __non_exhaustive elements
2018-09-16 14:27:37 +08:00
206a00915b
Export the mdbook version from the crate root
2018-09-16 14:22:50 +08:00
09667c9956
Configurable preprocessor ( #658 )
...
* The preprocessor trait now returns a modified book instead of editing in place
* A preprocessor is told which render it's running for
* Made sure preprocessors get their renderer's name
* Users can now manually specify whether a preprocessor should run for a renderer
* You can normally use default preprocessors by default
* Got my logic around the wrong way
* Fixed the `build.use-default-preprocessors` flag
2018-09-10 18:55:58 +08:00
d729a762fe
Remove insertion on non alphabetic initial headings
2018-09-09 12:00:28 +08:00
43b3d157d9
(test) validate id from non ascii headings
2018-09-09 12:00:25 +08:00
34356b87a0
Document dest-dir relative path behavior
2018-09-06 10:24:42 -05:00
65198a7632
Fix paths to additional CSS and JavaScript files
...
Expressions in an `#each` block need to begin with "../" to reference
values in the main context.
2018-08-31 20:03:34 -05:00
3688f73052
rustfmt
...
using rustfmt 0.99.2-nightly
2018-08-21 10:58:44 -05:00
42aded9577
Fix table and quote related color
2018-08-12 02:47:06 +08:00
4cc3a1333b
(feat) update to handlebars 1.0
2018-08-05 15:08:47 +08:00
1d69ccae48
Run rustfmt
...
using 0.8.2-stable included in rustc 1.28.0
2018-08-02 20:22:49 -05:00
f30ce0184d
Fix escaped link preprocessor
2018-08-02 19:04:35 -05:00
b8f8e76899
Improve command-line argument parsing
2018-08-02 16:52:41 -05:00
b2eb1ace08
Fix relative paths in index.html
2018-08-02 12:43:40 -05:00
b3665c287d
Add directory argument to `mdbook test`
2018-08-01 17:59:40 -05:00
47f85e71a8
Use stable rust playground API
...
and also add timeouts to these fetches.
2018-08-01 12:38:36 -05:00
8ba1830750
Merge pull request #752 from mattico/icon-margin-padding
...
Icon button hit-test dead-space fix
2018-07-30 19:19:31 -05:00
76c1c9e0a8
Merge pull request #751 from mattico/update-playpen-bt
...
Fix rust playground execute API
2018-07-30 19:18:18 -05:00
d054140117
Fix rust playground execute API
2018-07-30 19:17:53 -05:00
512826c465
Fix hiding theme menu
2018-07-30 19:06:50 -05:00
99019b74aa
Remove hit-test dead space between buttons
2018-07-30 19:03:29 -05:00
abfc3009fc
Add a "noplaypen" class for rust code samples.
...
This class will supress the "play" button in the html backend (which you
can also do with the "ignore" class), but it will still let the code be
tested via `mdbook test` (which is not possible with the "ignore" class).
This is useful for code examples that don't really do much (and so the
user doesn't gain much from running them), but as an author you still
want to test them to guard against syntax errors and typos and the like.
2018-07-26 17:55:14 -04:00
05f3c693a7
Ensure theme selection button is the full-width of the menu
2018-07-26 15:28:09 -05:00
8b3038e3ef
Remove unconditional searchindex.js load
...
which should have been included in #707
2018-07-26 15:28:09 -05:00
bc432c8f42
Fix favicon in subfolders
2018-07-26 15:28:09 -05:00
e88970d172
Don't use CSS variables in media queries
...
since they don't work :'(
2018-07-26 15:28:09 -05:00
ac38f05bb6
Change template to use new CSS
2018-07-26 15:28:05 -05:00
3119a7e4bf
Fix several CSS bugs
2018-07-26 13:49:57 -05:00
cc745d04f2
Merge css files
2018-07-26 13:37:22 -05:00
d1a23109e2
Convert stylus files to CSS
2018-07-26 13:37:22 -05:00
e7afb3340c
Reduce the margins on header icons on narrow devices
2018-07-25 13:28:05 -05:00
b4e15e5357
Merge pull request #741 from mattico/fix-mdbook-test
...
Fix `mdbook test`
2018-07-25 12:56:28 -05:00
fd9d27e082
rustfmt
2018-07-25 12:20:48 -05:00
0e1787c617
Don't run index preprocessor on `mdbook test`
2018-07-25 12:19:01 -05:00
a08255316a
Prevent certain mobile browsers from enlarging fonts in landscape orientation
2018-07-25 11:25:09 -05:00
c9a9987aec
Merge pull request #738 from mattico/fix-cargo-bin
...
Move subcommand modules to match cargo conventions
2018-07-24 16:46:57 -05:00
5dd0496a4f
Update dependencies
...
`crossbeam` and `time` are removed since they're no longer used.
2018-07-24 16:40:34 -05:00
f300a21a47
Move subcommand modules to match cargo conventions
2018-07-24 16:34:49 -05:00
b88abb171c
Merge pull request #710 from Eyenseo/master
...
Fix different font sizes in editor and code
2018-07-24 13:34:34 -05:00
4f793af53b
Allow sidebar section titles to overflow
2018-07-24 12:00:48 -05:00
29b3ff14c7
Merge pull request #719 from lucasem/patch-1
...
rustdoc codeblock hash escape
2018-07-24 11:09:28 -05:00
5835da2432
Run rustfmt
2018-07-23 12:47:04 -05:00
d9dbba49ea
Fix for relative paths
2018-07-23 12:19:59 -05:00
384582aeba
Cleanup add_doc
2018-07-23 12:08:04 -05:00
e1a46d213e
Use JSON search index with JS fallback
...
This allows the search index to be loaded asynchronously, and should
use fewer resources as it doesn't have to execute the JS.
JS loading is kept as a fallback for CORS issues with file:// URIs in Chrome.
2018-07-23 12:08:04 -05:00
62c8311301
Don't copy search js when disabled
2018-07-23 12:08:04 -05:00
b8011de3e8
Warn when search index is >10MB
2018-07-23 12:08:04 -05:00
019e74041d
Use integer doc_refs to shrink the search index
...
This change reduced the searchindex.js of book_example from 508KB to 317KB.
2018-07-23 12:08:04 -05:00
8cd7061ff2
Add search.enable config field
2018-07-23 12:08:04 -05:00
cae8a8ffe2
Only fetch crates list on pages with playpens
2018-07-16 19:17:00 -05:00
bdb37ec117
Use relative links and translate internal references ( #603 )
...
* Relative links for 0.1.8
* Compat for IE11 search
2018-07-11 21:33:44 +08:00
374e1d3f94
rustdoc codeblock hash escape
...
pending merge of rust-lang/rust#51803
2018-07-04 16:54:55 +04:00
b452d5e0c7
Fix different font sizes in editor and code
...
Fixes #705
2018-06-19 22:28:23 +02:00
289028850f
Use `saturating_sub` instead of `checked_sub.unwrap_or`
2018-06-04 01:42:09 +09:00
2a55ff62f3
Recursively apply preprocessor ( #682 )
2018-05-20 18:36:19 +08:00
27b29fdaf2
Merge pull request #696 from mattico/fix-theme-dir
...
Fix default theme dir selection
2018-05-16 21:58:41 +02:00
154e0fb308
Rustfmt
2018-05-16 12:08:23 -05:00
0de177a344
Add a warning for possible theme directories which will no longer be used
2018-05-16 12:06:55 -05:00
d7759fbf4d
Remove underscore from FontAwesome directory
2018-05-15 12:34:44 -05:00
f84e670edd
Add a .nojekyll file
...
to allow users to have other files with leading underscore names.
2018-05-15 12:34:44 -05:00
9a9c625319
Fix default theme dir selection
2018-05-14 14:52:29 -05:00
b9ca108fca
Support reproducible builds by forcing window.search to use stable key ordering. ( #692 )
2018-05-14 18:22:21 +08:00
69599646e7
Add index preprocessor ( #685 )
...
* Add index preprocessor
README.md is a de facto index file in markdown-based documentation.
Hence, we respect to README.md and convert it into index.html.
* Fix warning for unused variables
* Update tests for config
* Match file stem case-insensitively for IndexPreprocessor
* Add tests for IndexPreprocessor
* Update book example to fit index preprocessor
2018-05-04 19:41:28 +08:00
69fef40e57
Improve print output ( #680 )
...
* Update print styles for new sidebar behavior
* Hide copy icons in print output
* Wait for mathjax rendering to complete before printing
* Remove old wrapping css
Browsers this old are already hilariously broken, so we don't need these fallbacks.
* Change mathjax script type
Chrome won't execute this if it's not marked as js
* Ensure page has rendered before printing
In certain situations Chrome willl fire window.onLoad before it's
done rendering. Add a 100ms delay to work around this.
2018-05-01 20:29:34 +08:00
e7a61efb39
Fix warning
2018-04-22 13:01:10 -05:00
1c71eaa964
Put the search bar into an HTML form ( #669 )
...
This enables "Add a keyword for this search" in the contex menu for the
search field, in Firefox and other browsers.
2018-04-21 23:27:51 +08:00
41399fc29c
Revert "Fixes the search box overlapping with content when first shown ( #666 )" ( #667 )
...
This reverts commit 7f82a197b9
2018-04-11 10:23:56 +08:00
7f82a197b9
Fixes the search box overlapping with content when first shown ( #666 )
2018-04-10 22:02:27 +08:00
71d44933f0
Replace his with their in reference to reader ( #665 )
...
The reader should not be assumed male; I'm a developer and user,
I'm not male. Makes documentation's language gender neutral to
make it more welcoming to people that do not use he/him pronouns.
2018-04-10 07:02:53 +08:00
f01bf88e69
Fix several theme issues ( #648 )
...
* Don't hide page content when displaying search
* Decrease sidebar animation time
* Fix search key event handler
which wasn't completely de-jqueryified.
* Avoid reflowing page content on small screens
This reduces jank caused by reflowing the page text while animating the
sidebar, and it looks nicer.
* Don't use HTMLParentNode.prepend()
since edge doesn't support it yet
* Don't animate menu border bottom color
since it's the same color as the background, which isn't animated.
* Small CSS improvments
- Remove invalid `pointer: cursor` style
- Disable transitions for noscript to stop page from spazzing on every load
- Add `cursor: pointer` to mark
- Disable `cursor: pointer` on noscript menu-title
* JS fixes
- Load MathJax async
- Always use local fontawesome and clipboard.js
- Move js class to html element to make theme switching easier
* Give the print button a bit more margin
2018-04-09 12:10:44 +08:00
b5ea84c60d
Remove unnecessary travis jobs ( #664 )
...
* Removed all the unnecessary CI jobs
* Updated dependencies
* Removed a deprecation warning
2018-04-07 15:47:08 +08:00
148c806e34
Prevent search from triggering when editing code ( #653 )
2018-04-07 06:31:51 +08:00
55f7ed1c37
Replace tempdir by tempfile ( #650 )
...
The former has been deprecated in favor of the latter
2018-03-27 07:47:37 +08:00
eb0f7179ab
Use `git config` to get author name in `mdbook init` ( #649 )
...
* Use `git config` to get author name in `mdbook init`
* Return `None` if `git` command fails
* Use `.ok()?` to convert from Result to Option and return early if `None`
2018-03-26 22:37:11 +08:00
5fb3675151
Update elasticlunr-rs ( #646 )
...
* Update dependencies
* Use config structs from elasticlunr-rs
* Update searchindex fixture
2018-03-20 20:22:35 +08:00
Bas Bossink
Eric Huss
Allen
Philipp Hansch
Stefanie Jäger
lzutao
Dylan DPC
Federico Fissore
Donald Pinckney
Carol (Nichols || Goulding)
Sebastian Köln
Adam Perry
Rongsong Shen
Cauê Baasch de Souza
Steve Klabnik
Stéphane Derosiaux
k-nasa
gentoo90
Bas Bossink
Desmond
Michael Bryan
Matt Ickstadt
yoshimura masataka
Jason Liquorish
Jan-Erik Rediger
Jan-Erik Rediger
Weihang Lo
wirelyre
Ning Sun
Andrew Chin
cetra3
Lucas Morales
eyenseo
Hiroki Noda
Andrew Gauger
Mathieu David
Tim Ryan
Weihang Lo
Matt Brubeck
Gwen Lofman
Nils
Bastien Orivel
Anders Rasmussen