5dd2a5bff4
implement support for book parts
2020-05-17 16:53:06 -05:00
1b3b10d2ae
Do not allow the sidebar to be dragged outside the window. ( #1229 )
2020-05-17 22:05:12 +02:00
2c26c65f4d
Remove google fonts by serving them locally
...
Co-authored-by: Aral Balkan <aral@ind.ie>
Co-authored-by: Collyn O'Kane <47607823+okaneco@users.noreply.github.com>
2020-05-15 02:48:28 -03:00
6038af292f
Remove some unnecessary blocks.
2020-05-10 09:23:40 -07:00
43008ef2ef
fix issues from code review
2020-05-10 09:04:02 -07:00
d605938886
Bring back draft chapters
2020-05-10 09:04:02 -07:00
c2d58158da
Revert HTML auto-formatting
2020-05-10 08:42:53 -07:00
61c8413138
Allow to define own HTML <head> attributes
...
Create a `index.hbs` template file to render additional HTML <head> attributes
2020-05-10 08:42:53 -07:00
8ee950e3de
Merge pull request #1214 from ehuss/fix-clippy
...
Fix some clippy warnings.
2020-05-10 08:39:19 -07:00
c44ef1b2f0
Fix some clippy warnings.
2020-05-10 08:29:50 -07:00
07dfc4b89a
Merge pull request #1207 from toyboot4e/fix-mdbook_book
...
Enable `MDBOOK_BOOK` to overwrite `book.toml`
2020-05-08 06:51:21 -07:00
282e55122e
Update src/config.rs
...
Co-authored-by: Eric Huss <eric@huss.org>
2020-05-08 19:56:41 +09:00
b1cf3f117d
Links preprocessor: support pluses in file paths
2020-05-03 14:50:03 +02:00
d665732056
Links preprocessor: test links with special characters
2020-05-03 14:42:22 +02:00
2f59dbf1ef
Fix example of MDBOOK_BOOK (again)
2020-05-03 18:58:41 +09:00
3a63276727
Not to use `matches!`
2020-05-03 18:16:44 +09:00
4c64f23089
Fix example of MDBOOK_BOOK
2020-05-03 17:54:35 +09:00
683d2b2240
Fix use of MDBOOK_BOOK
2020-05-03 17:54:17 +09:00
2732c5e8f7
Update docs and tweak error messages.
2020-04-21 15:34:59 -07:00
6b550cb4bb
Make missing backends optional.
2020-04-21 15:13:14 -07:00
28ce8f5ac0
Some edition cleanup and fixes.
2020-04-21 12:26:48 -07:00
255756cfee
Make new [rust] config and move edition config under it
2020-04-21 10:24:47 -07:00
53d821bf6d
Add edition to hbs renderer
2020-04-21 10:24:47 -07:00
d39d4517aa
Add support for Rust edition
2020-04-21 10:24:47 -07:00
1d265fd143
Broaden scope of suppressed warnings for listings without a main fn
...
At present, code listings without a main function will be wrapped in one and
annotated with an allow lint check attribute provided by the following [code][]:
```
format!(
"\n# #![allow(unused_variables)]\n{}#fn main() {{\n{}#}}",
attrs, code
)
```
A broader lint check attribute such as `#![allow(unused)]` seems like it might
better fit the apparent intent of this code.
Addresses: https://github.com/rust-lang/mdBook/issues/1192
[code]: 769cc0a7c1/src/renderer/html_handlebars/hbs_renderer.rs (L635-L638)
2020-04-18 01:36:11 -04:00
99ecd4f87c
Merge pull request #1170 from ehuss/fix-theme-focus
...
Fix theme selector focus.
2020-04-03 12:45:33 -07:00
e839ef0866
Fix sidebar line-height. ( #1182 )
2020-04-03 21:09:23 +02:00
c2686a817a
Address PR review comments
2020-04-03 10:39:15 -07:00
bd14d0910a
Avoid a possible recursive copy when destination (build_dir) is underneath source directory. Update docs to match.
2020-04-03 10:39:15 -07:00
6eb597a556
Revert "Assure copy_files_except_ext(..) won't copy directories into itself ( #1135 )" ( #1181 )
...
This reverts commit d7a2b29f06
2020-04-03 19:12:43 +02:00
59568208ff
Revert "Support anchors in SUMMARY ( #1173 )" ( #1175 )
...
This reverts commit 2baed040c2
2020-03-24 23:52:24 +01:00
21a16c9b75
Scroll sidebar to middle instead of top. ( #1161 )
...
* Fix: Scroll sidebar to current active section (#1067 )
* Clean: Some code related to PR #1052
* Change `scrollIntoViewIfNeeded` with `scrollIntoView`
* Don't use onload event for sidebar scroll to reduce flickering.
Co-authored-by: 李鸿章 <poodll@163.com>
2020-03-24 21:08:53 +01:00
4e8e1e1408
Don't highlight code spans in headers. ( #1162 )
2020-03-24 20:43:20 +01:00
2baed040c2
Support anchors in SUMMARY ( #1173 )
...
* Parse anchors in `SUMMARY.md`
* Support sub-links in SUMMARY with html renderer
* Add some tests for anchors
2020-03-24 19:15:28 +01:00
f7ffffbd1e
Fix theme selector focus.
2020-03-20 11:12:42 -07:00
b82562fe8a
Fix SUMMARY's parse_numbered with comment
2020-03-18 12:28:27 +09:00
44c3213f5d
Merge pull request #1130 from sunng87/feature/handlebars-3.0
...
Update handlebars to 3.0
2020-03-08 18:54:39 -07:00
fd56a53e76
ui: improve menu folding ( #989 )
...
* ui: improve menu folding
Fold/unfold the menu bar just by the amount of scroll, not by its
full width
* refactor: use a variable for the menu bar height
* Fix menu scroll jittering, remove hover folding smoothness
Rewrite it to use `position:` `sticky` and `relative` instead
of continuous programmatic position changes
On-hover folding-unfolding transition removal is a side-effect
2020-03-06 01:11:37 +01:00
ca4b85b815
Increases line height for p, ul & ol ( #1136 )
2020-03-06 01:06:19 +01:00
d7a2b29f06
Assure copy_files_except_ext(..) won't copy directories into itself ( #1135 )
...
This prevents recursive copy-loops when the destination directory
is contained in the source directory.
Now it bails out with a descriptive error message.
2020-02-29 19:20:55 +01:00
2bd8bdf798
Support rel=next and rel=previous
...
This resolves GH #1149
2020-02-18 09:20:17 -06:00
0da7ba4abe
Corrects inner/outer space in sidebar <li>s ( #1137 )
2020-02-17 22:04:59 +01:00
95fba3f357
Add a case for an empty `book_title` parameter
...
Html page title for every chapter in the book is created by the following code:
```rust
let title: String;
{
let book_title = ctx
.data
.get("book_title")
.and_then(serde_json::Value::as_str)
.unwrap_or("");
title = ch.name.clone() + " - " + book_title;
}
```
If the `book.toml` file is missing, and `book_title` parameter is empty, there's an awkward ` - ` string hanging at the end of each chapter's title.
This PR adds a `match` case to handle that kind of situation.
2020-02-15 23:13:37 +01:00
b8fc7a1b2d
fix: ayu theme meta highlighting
2020-01-30 09:57:45 -06:00
1947f8ca65
Update handlebars to 3.0
2020-01-24 11:01:44 +08:00
2f59943c04
rustfmt with 1.40
...
Some slight changes in formatting in 1.40.
2019-12-31 16:23:25 -08:00
6a94492238
fix scroll issue ( #1108 )
...
* fix sidebar scrolling
* fix query selector
2019-12-02 11:07:24 +01:00
49b7f08164
Fix doc comment of `BuildConfig::create_missing` ( #1104 )
2019-11-29 06:22:21 +01:00
7def6d70e8
Merge pull request #1099 from Michael-F-Bryan/expose-execute-build-process
...
Exposed the MDBook::execute_build_process() method to 3rd parties
2019-11-23 10:44:58 -08:00
730d7f8410
Exposed the execute_build_process() method to 3rd parties
2019-11-17 20:59:55 +08:00
b6603468d6
Stop scrolling on socket reload
2019-11-12 18:06:11 -08:00
2a3088422a
Upgrade pulldown_cmark to 0.6.1
2019-11-11 20:25:38 +01:00
1f505c2b2e
Revert "Add support for Rust edition 2018 in playpens ( #1086 )" ( #1093 )
...
This reverts commit a7b3aa0444
2019-11-11 13:24:13 +01:00
a7b3aa0444
Add support for Rust edition 2018 in playpens ( #1086 )
...
* Add support for Rust edition 2018 in playpens
* Add Rust edition support to rustdoc
* Run rustfmt
* Fix enum variant reference
2019-11-11 12:42:24 +01:00
a9160acd64
Merge pull request #1088 from benediktwerner/master
...
Fix hiding of empty boring lines
2019-11-07 07:44:47 -08:00
4c1bca1684
Don't hide macro lines
2019-11-07 02:42:02 +01:00
8fffb2a704
Hide lines in ignored code blocks
2019-11-07 02:20:10 +01:00
3ea0f9b745
Lowercase matching the theme name ( #1079 )
...
* Using .to_lowercase() on the theme matching to avoid needed exact capitolization in the book.toml
* Changed the default-dark-theme from .to_string() to .to_lowercase() to match theme
2019-11-05 13:55:08 +01:00
f5549f2267
Hide empty lines starting with '#' in playpens
2019-11-04 14:03:25 +01:00
e2a8600712
Remove outdated unused var in theme js code
2019-11-04 14:03:24 +01:00
f79d5d4582
rust-lang-nursery -> rust-lang
...
Fixes #1080
2019-10-29 08:04:16 -05:00
820714a560
Use only relative font sizes ( #894 )
...
This replaces the only use of px for font-sizes by setting up a base
rem size on the root element in a way that is easy to calculate (1 rem =
10px) and scaling up according to browser settings.
2019-10-27 15:51:32 +01:00
86a368b726
Introduce a --menu-bar-height CSS variable
2019-10-26 13:21:26 +01:00
1dc482b00d
Add scroll-margin-top to headings which contain link targets.
...
This means when the link is followed, the page scrolls in such a way as to
leave space for the fixed menu bar.
Fixes #1040
2019-10-26 12:55:12 +01:00
21d8f394ae
Fix "next chapter" spacer handling. ( #1075 )
2019-10-25 17:33:21 +02:00
c9dae170f3
Better automatic dark mode ( #1069 )
...
* Don't save default theme to localStorage
* Auto enable dark mode on no-js
* Fix light theme with no-js
2019-10-23 12:15:59 +02:00
a592da33bb
fix the behavior of sticky header ( #1070 )
2019-10-19 10:07:41 +02:00
6af6219e5b
[Feature] expandable sidebar sections (ToC collapse) ( #1027 )
...
* render(toc): render expandable toc toggle
* ui(toc): js/css logic to toggle toc
* test: update rendered output css selector
* config: add `html.fold.[enable|level]`
* renderer: fold according to configs
* doc: add `output.html.fold`
* refactor: tidy fold config
- Derive default for `Fold`.
- Use `is_empty` instead of checking the length of chapters.
2019-10-19 09:56:08 +02:00
e5f74b6c86
Option to display copy buttons. ( #1050 )
...
* Option to display copy buttons.
- Added field to playpen data structure
- Communicate through window.playpen_copyable
- Javascript updated to check before displaying copy buttons.
* html -> html_config
Also:
- update description of copyable in source code.
- update description of line_numbers (my last PR to this repository)
2019-10-17 12:44:54 +02:00
84a2ab0dba
Reapply: Move hiding of boring lines into static content ( #846 ) ( #1065 )
...
* Move hiding of boring lines into static content (#846 )
* Fix test for hidden code
2019-10-16 11:27:14 +02:00
d63ef8330d
Add `!important` to `code {font-family}` property ( #1062 )
...
If accepted, this will fix #1061
2019-10-11 14:21:13 +02:00
01e50303a2
add a command to playpen ( #1066 )
2019-10-11 14:16:06 +02:00
2b3304cb8b
Revert "Move hiding of boring lines into static content ( #846 )" ( #1064 )
...
This reverts commit 4448f3fc4b
2019-10-10 14:31:55 +02:00
4448f3fc4b
Move hiding of boring lines into static content ( #846 )
2019-10-10 13:55:29 +02:00
859659f197
Fix inline code display css ( #1058 )
2019-10-07 09:24:35 +02:00
4a93eddae2
Fix "next" navigation on index.html (take 2). ( #1005 )
2019-10-06 17:55:36 +02:00
0173451b67
Fix error message for missing output.html. ( #1056 )
2019-10-06 00:33:50 +02:00
ac1749ff2f
Implement a `rustdoc_include` preprocessor ( #1003 )
...
* Allow underscores in the link type name
* Add some tests for include anchors
* Include parts of Rust files and hide the rest
Fixes #618 .
* Increase min supported Rust version to 1.35
* Add a test for a behavior of rustdoc_include I want to depend on
At first I thought this was a bug, but then I looked at some use cases
we have in TRPL and decided this was a feature that I'd like to use.
2019-10-06 00:27:03 +02:00
8cdeb121c5
Merge pull request #1055 from amanjeev/amanjeev/clean-command
...
Fix (command:clean): removes error message 'dir not found' if 'clean' is run multiple times
2019-10-05 14:03:31 -07:00
74313bb701
Fix (command:clean): removes error message 'dir not found' if 'clean' is run multiple times (uses existing path variable)
2019-10-05 15:59:34 -04:00
3c25dba9b4
Revert "Fix (command:clean): removes error message 'dir not found' if 'clean' is run multiple times"
...
This reverts commit 2387942588
2019-10-05 15:57:10 -04:00
2387942588
Fix (command:clean): removes error message 'dir not found' if 'clean' is run multiple times
2019-10-05 15:01:01 -04:00
93c9ae5700
Merge pull request #1037 from Flying-Toast/prefers-color-scheme
...
Automatically use a dark theme according to 'prefers-color-scheme'
2019-10-05 11:33:52 -07:00
9efa9fd1c4
Merge pull request #1052 from morphologue/fix-sidebar-autoscroll
...
Fix #1029 sidebar not auto-scrolling
2019-10-05 10:19:29 -07:00
8a33407cc5
Merge pull request #1051 from segfaultsourcery/fix-small-gitignore-bug
...
I fixed a small gitignore bug
2019-10-05 10:11:16 -07:00
699844a5c3
Fix #1029 sidebar not auto-scrolling
2019-10-05 16:54:09 +10:00
9bdec5e7cc
preferred-dark-theme defaults to default-theme
2019-10-04 19:32:03 -04:00
930f730361
The .gitignore file is now searched for recursively.
...
Removed a warning if .gitignore is missing.
2019-10-04 22:56:56 +02:00
09c738468f
Merge pull request #1047 from rnitta/patch-1
...
Fix Search::use_boolean_and documents
2019-10-04 12:39:05 -07:00
a3d1afdd1f
This fixes a small bug where the gitignore location can be misinterpreted to be in the folder "above" where it actually is.
2019-10-04 19:44:36 +02:00
8e8e53ae15
Added support for gitignore files. ( #1044 )
...
* Added support for gitignore files.
The watch command will now ignore files based on gitignore. This can be useful for when your editor creates cache or swap files.
* Ran cargo fmt.
* Made the code a bit tidier based on input from other Rust programmers.
Changed the type of the closure back to use PathBuf, not &PathBuf.
Reduced nesting.
2019-10-04 14:59:17 +02:00
5fe801a7d1
fix Search::use_boolean_and documents
2019-10-03 11:35:42 +09:00
a6f317e352
Update highlight.js ( #1041 )
2019-09-30 00:07:54 +02:00
a058da8b74
Fix merge conflict.
2019-09-26 11:03:51 -07:00
73be1292ab
Merge pull request #1035 from andymac-2/line-numbers
...
Added line numbers to editable sections of code.
2019-09-26 10:53:32 -07:00
98ecd1178b
Merge pull request #1033 from TjeuKayim/log-deserialization-error-html-config
...
Log deserialization errors for [html.config]
2019-09-26 10:28:18 -07:00
b88839cc25
Rustfmt for 1.38.
...
A minor change in the recent stable release.
2019-09-26 09:54:12 -07:00
b0ae14a2c7
Automatically use a dark theme according to 'prefers-color-scheme'
2019-09-25 19:11:28 -04:00
81ab2eb7db
Added line numbers to editable sections of code.
...
- Added line numbers to config struct
- Added playpen_line_numbers field to hbs renderer.
- Added section to set `window.playpen_line_numbers = true` in page template
- Use line number global variable to show line numbers when required.
2019-09-24 21:27:02 +08:00
213171591a
De-duplicate calling Config::html_config()
2019-09-22 21:48:49 +02:00
db13d8e561
Log HtmlConfig deserialization errors
2019-09-22 21:48:03 +02:00
a873d46871
Implement a markdown renderer ( #1018 )
...
Use case: when trying to `mdbook test` a file that has many `include`
directives, and a test fails, the line numbers in the `rustdoc` output
don't match the line numbers in the original markdown file.
Turning on the markdown renderer implemented here lets you see what is
being passed to `rustdoc` by saving the markdown after the preprocessors
have run.
This renderer could be helpful for debugging many preprocessors, but
it's probably not useful in the general case, so it's turned off by
default.
2019-08-30 12:20:53 +02:00
ce0c5f1d07
Another refactoring in links.rs ( #1001 )
...
* Extract the concept of a link having a range or anchor specified
So that other kinds of links can use this concept too.
* Extract a function for parsing range or anchor
2019-08-13 11:19:42 +02:00
e880fb6339
Fix #823 : Apply default padding to table headers
...
This PR fixes #823 by applying the default padding for table cells (`padding: 3px 20px;`) to header cells.
2019-08-09 09:48:56 -07:00
a8d6337ac6
Merge pull request #994 from WofWca/nav-chapters-style
...
ui: Improve next/prev chapter links' style
2019-08-07 11:27:20 -07:00
f37a89cd4c
Merge pull request #998 from integer32llc/links-improvements
...
Refactoring of some functionality in links.rs
2019-08-07 10:33:11 -07:00
aaeb3e2852
Merge pull request #985 from Michael-F-Bryan/enable-caching
...
Allow backends to cache previous results
2019-08-07 10:26:06 -07:00
8c4b292d58
Rework a match to possibly be more understandable
2019-08-06 22:14:17 -04:00
40159362c0
Unnest another conditional
2019-08-06 22:14:16 -04:00
aa67245743
Unnest a conditional
2019-08-06 22:14:16 -04:00
d968443074
Don't bother splitting the path after the 3rd colon
2019-08-06 22:14:16 -04:00
3716123e10
Increase test coverage of parse_include_path
2019-08-06 22:14:16 -04:00
50a2ec3cf1
Ensure the iterator will always return None after the first None
...
I'm not sure in what cases this iterator might possibly return Some
again, but let's make absolutely sure.
2019-08-06 22:14:16 -04:00
07459aef60
Factor out the use of different ranges from linktype
...
This eliminates some duplication and will enable different kinds of
LinkTypes to have line number ranges.
Implement `From` for the std `Range` types to enable easier
construction.
The new code reaaalllly makes me wish for a delegation mechanism though
:(
2019-08-06 22:14:16 -04:00
1c5dc1e310
ui: Improve next/prev chapter links' style
2019-08-03 22:56:25 +08:00
e512850c13
fix(css/chrome): Use standard property for scrollbar ( #816 )
...
This was recently standardized and is currently implemented in Firefox Nightly.
2019-07-28 21:01:33 +02:00
bb412edf53
Made sure the tests pass
2019-07-21 04:32:28 +08:00
e56c41a1c2
The HTML renderer now cleans its own build directory
2019-07-21 02:37:09 +08:00
d1b5a8f982
The MDBook::build() method no longer cleans the renderer's build directory
2019-07-21 02:35:18 +08:00
d29a79349c
Add include by anchor in preprocessor.
2019-07-14 21:55:51 -04:00
b91e5c8807
Merge pull request #977 from sunng87/feature/handlebars-2.0
...
(feat) update handlebars to 2.0
2019-07-12 09:56:51 -07:00
2d11eb05fe
(feat) update handlebars to 2.0
2019-07-13 00:11:05 +08:00
3d45e40693
Small cleanups of variable/field names ( #970 )
...
* Rename a variable from playpen to link
Links can now be more than only playpen links
* Rename a field to match the enum type it holds
Also so that link.link.stuff doesn't happen when a variable link holds a
Link instance
2019-07-04 11:31:04 +02:00
228e99ba11
Fix even more print page links. ( #963 )
2019-07-01 17:52:25 +02:00
bb3398bdbb
Merge pull request #941 from rnitta/configurable-language
...
Change language attribute of the book to configurable
2019-06-24 08:56:22 -07:00
a2029f0a78
Merge pull request #959 from jeremystucki/refactoring
...
Minor Refactoring
2019-06-20 20:05:02 -07:00
7c33ac800c
Merge pull request #962 from integer32llc/rangebounds
...
Use stdlib RangeBounds
2019-06-20 20:01:52 -07:00
abddd7c6f7
Use stdlib RangeBounds
2019-06-20 21:56:31 -04:00
92a7b0cdcd
Use iterator instead of for loop
2019-06-20 15:12:56 +02:00
592140db5b
Remove redundant closure
2019-06-20 14:56:47 +02:00
3a0eeb4bbb
Remove needless scope
2019-06-20 14:29:14 +02:00
a9dae326fa
Use unwrap_or instead of match on Result
2019-06-20 14:27:57 +02:00
abba959add
Remove needless lifetime
2019-06-20 14:18:31 +02:00
ea15e55829
Use map instead of match on Option
2019-06-20 14:18:17 +02:00
b83c55f7ef
Switch to the standard library's fs::read_to_string
2019-06-19 22:49:18 -04:00
07830f7f11
Merge pull request #891 from integer32llc/include-before-test
...
Write preprocessed content to file before testing with rustdoc
2019-06-12 15:01:58 -07:00
2497e77bf1
Support strikethrough and tasklists. ( #952 )
2019-06-12 17:02:03 +02:00
0c2292b9aa
Update css to support diff syntax highlighting. ( #943 )
...
This adds the rules to highlight diff lines with highlight.js.
2019-06-12 16:59:55 +02:00
3cfed10098
Update to pulldown-cmark 0.5. ( #898 )
...
* Update to pulldown-cmark 0.4.1.
* Update to pulldown-cmark 0.5.2.
* Remove pulldown-cmark-to-cmark dependency.
Since it is not compatible with the new pulldown-cmark. This example isn't
directly usable, anyways, and I think the no-op example sufficiently shows how
to make a preprocessor.
* cargo fmt
* Fix example link.
2019-06-11 18:26:24 +02:00
a655d5d241
Header elements wrap links ( #948 )
...
* swap hierarchy of header for that of link
* fix comment
2019-06-03 14:31:15 +02:00
f8c3a2deea
Update highlight.js ( #942 )
...
Updates to v9.15.8.
My main motivation is to fix a minor issue with TOML highlighting.
This keeps the same language list as before with the addition of a new "common"
language `properties` and added `julia` because someone asked for it and I like
julia. The full list from building:
:common armasm d go handlebars haskell julia rust scala swift x86asm yaml
- apache
- armasm
- bash
- coffeescript
- cpp
- cs
- css
- d
- diff
- go
- xml
- handlebars
- haskell
- http
- ini
- java
- javascript
- json
- julia
- makefile
- markdown
- nginx
- objectivec
- perl
- php
- properties
- python
- ruby
- rust
- scala
- shell
- sql
- swift
- x86asm
- yaml
2019-06-03 14:22:32 +02:00
b226d2fc55
cargo fmt
2019-05-31 09:19:46 -07:00
53ba0d6655
Remove 'static lifetime from static vars ( #947 )
2019-05-31 18:01:02 +02:00
43ead86ecc
Update toml. ( #945 )
...
Just keeping up-to-date.
2019-05-31 18:00:15 +02:00
1d3ec7e0c7
Support rust edition in playground. ( #946 )
...
The endpoint was recently updated to support the edition param.
2019-05-31 17:59:44 +02:00
672cf456eb
Remove unnecessary ::<crate>
...
Find and replace with `git grep -E '\W::[a-z]'` command.
2019-05-30 23:12:33 +07:00
4f7c299de7
update language attribute to configurable
2019-05-30 11:53:49 +09:00
71281bff10
Update some updatable dependencies ( #934 )
...
* Update ammonia dependency
* Update env_logger
* Update itertools
* Update ws dep
* Update pretty_assertions dep
2019-05-26 14:05:42 +02:00
8542f7f29d
Transition to 2018 edition ( #933 )
...
* Transition to 2018 edition
* Update Travis CI badge in README
* Remove non-idiomatic `extern crate` lines
2019-05-25 20:50:41 +02:00
882014860c
Update ace editor to v1.4.4 ( #935 )
2019-05-25 14:39:16 +02:00
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
mark
Eric Huss
Aphek
Mathieu David
Gilles Rasigade
toyboot4e
Tomasz Kurcz
Kim Hermansson
kngwyu
Gabriel Majeri
Mike English
Andrew Mackenzie
Dylan DPC
Martin Carton
dalance
Sebastian Thiel
Evan Carroll
Sergey Pedan
Tomasz Różański
Avery Harnish
Ning Sun
Arashmidos
nickelc
Michael Bryan
Dylan Owen
Marcus Klaas de Vries
Benedikt Werner
Ricky
Steve Klabnik
Rostislav
Matthew Woodcraft
rnitta
Weihang Lo
Andrew Pritchard
David Omar Flores Chávez
Adrian Heine né Lang
Chris Ladd
Carol (Nichols || Goulding)
Amanjeev Sethi
morphologue
Flying-Toast
Kim Hå
Tjeu Kayim
Stephan Druskat
Carol (Nichols || Goulding)
WofWca
Sorin Davidoi
Benoît CORTIER
Jeremy Stucki
lzutao
Bas Bossink
Allen
Philipp Hansch
Stefanie Jäger
Federico Fissore
Donald Pinckney
Sebastian Köln
Adam Perry
Rongsong Shen
Cauê Baasch de Souza
Stéphane Derosiaux
k-nasa
gentoo90
Bas Bossink
Desmond
Matt Ickstadt
yoshimura masataka
Jason Liquorish
Jan-Erik Rediger
Jan-Erik Rediger
Weihang Lo
wirelyre
Andrew Chin
cetra3
Lucas Morales
eyenseo
Hiroki Noda
Andrew Gauger
Mathieu David
Tim Ryan
Matt Brubeck
Gwen Lofman
Nils
Bastien Orivel
Anders Rasmussen