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
Tjeu Kayim
Carol (Nichols || Goulding)
Stephan Druskat
Eric Huss
Carol (Nichols || Goulding)
WofWca
Sorin Davidoi
Michael Bryan
Benoît CORTIER
Ning Sun
Jeremy Stucki
rnitta
lzutao
Bas Bossink
Allen
Philipp Hansch
Stefanie Jäger
Dylan DPC
Federico Fissore
Donald Pinckney
Sebastian Köln
Adam Perry
Rongsong Shen
Cauê Baasch de Souza
Steve Klabnik
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