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
62a727c041
Fix search ( #645 )
2018-03-16 07:37:08 +08:00
8c456666ff
Added a stability warning to the API docs
2018-03-14 23:48:57 +08:00
867fbfec05
Updated the call site for handlebars rendering
2018-03-14 23:48:56 +08:00
4af155e963
Exposed the sections inside a book ( #642 )
2018-03-14 23:47:17 +08:00
07719a8e0e
Adding for content to book.toml on init ( #627 )
...
* Obtaining author name from gitconfig
* Writing theme to config on init
* Addressing a FIXME came across
* Add request for book title.
2018-03-14 23:27:56 +08:00
cc92d665ca
Improve css so anchor don't go under sidebar ( #638 )
2018-03-14 23:23:55 +08:00
b86533b2a1
pulldown-cmark updated to 0.1.2, fixmes removed, new cargo.lock generated. ( #639 )
2018-03-11 22:17:38 +08:00
b2ad669c61
Search with Elasticlunr, updated ( #604 )
...
* Add search with elasticlunr.js
This commit adds search functionality to mdBook, based on work done by @phaiax. The in-browser search code uses elasticlunr.js to execute the search, using an index generated at book build time by elasticlunr-rs.
* Add generator comment
Someone on Reddit was wondering how the rust book was generated and said they checked the source. Thought I'd put this here. Might be a good idea to have a little footer "made with mdBook", but this'll do for now.
* Remove search/editor file override behavior
* Use for loop for book iterator
* Improve HTML regex
* Fix search CORS in file URIs
* Use ammonia to sanitize HTML
* Filter html5ever log messages
2018-03-07 21:02:06 +08:00
82aef1bc3f
fix(theme/book): Workaround focusout bug in macOS and iOS ( #630 )
2018-02-24 17:23:45 +08:00
38c883e1ef
Changing clap settings ( #624 )
2018-02-18 15:10:47 +08:00
8a00a004d8
Handle some cases when JavaScript is disabled ( #614 )
...
* feat(theme/index): Assume the sidebar is initially visible
In case the inline script does not execute, the fallback is to show the sidebar.
* feat(theme/index): Hide sidebar toggle and theme selector buttons when JavaScript is disabled
Makes no sense to show them in this case since they do not work.
2018-02-18 15:05:15 +08:00
d306aed587
Accessibility improvements ( #611 )
...
* fix(theme/book/themes): Check for control keys in event listener
* fix(theme/index): Menu role for theme selector
* fix(theme/book/themes): Handle focus when toggling theme list
* feat(theme/book/themes): Handle ArrowUp, ArrowDown, Home and End
2018-02-15 07:37:19 +08:00
89a5dbaf9a
fix(theme/stylus/sidebar): Contain scrolling to the sidebar ( #612 )
...
> A position fixed left navigation bar does not want to hand off scrolling to the document because a scroll gesture performed on the navigation bar is almost never meant to scroll the document. In this case, the author can use contain on the sidebar to prevent scrolling from being chained to the parent document element.
https://wicg.github.io/overscroll-behavior/#motivating-examples
2018-02-15 07:24:39 +08:00
07551760c9
feat(theme/stylus/sidebar): Reduce padding on non-touch devices ( #615 )
...
Closes #594 .
2018-02-15 06:59:55 +08:00
990daceed5
feat(theme/book): Scroll to top when clicking the page title ( #613 )
...
Common pattern, especially on mobile devices where the page can be quite long.
2018-02-09 18:34:18 +08:00
0bc1030a02
implement `clean` subcommand ( #583 )
2018-02-04 21:00:29 +08:00
43fcd00cd5
Inline footnotes. ( #600 )
2018-02-02 20:15:48 +08:00
bf9f58e11b
Add docs for mdBook specific include feature ( #593 )
...
* Add docs for mdBook specific include feature.
Also:
* Fix bug in take_lines taking `end`-many lines instead of
`end-start` many.
* Handle special case `include:number` as including a single line.
* Start counting lines at 1 and not 0.
* Merge mdBook and rust specific features into one chapter.
2018-01-31 18:57:47 +08:00
3ba71c570c
Handle input path with regards to custom css ( #598 )
...
* Handle input path with regards to custom css
Before, when someone like the Reference set their extra css as
"theme/reference.css" in their book.toml, this path would be treated as
relative to the invocation of mdbook, and not respect the input path. This
PR modifies these relative paths to do so.
Fixes the build of https://github.com/rust-lang/rust/pull/47753 which
blocks updating rustc to mdbook 0.1
* don't use file-name
the style name is theme/reference.css, this results in a Err(StripPrefixError(())), which means that we push only the file_name, losing the theme bit
2018-01-30 12:29:09 +08:00
674e58e747
fix(theme): Use aria-label alonside title ( #568 )
...
Tested this on macOS with VoiceOver, and it does not pick up the title as the text of the button. Kind of makes sense, since title and aria-label are not the same. This will make sure that the buttons and links are labeled properly.
2018-01-27 18:52:47 +08:00
50ee15472b
Updated the light theme to have a lighter scrollbar ( #590 )
2018-01-27 11:52:43 +08:00
ffb90bb9e2
Made sure we create the themes directory ( #586 )
2018-01-26 14:38:53 +08:00
186e649530
feat(src/theme): Scrollbar theme ( #563 )
2018-01-26 01:17:02 +08:00
b777a318f7
Expose functionality for creating core types ( #578 )
...
* You can now add chapters to a Book
* Made the RenderContext::new() constructor public
2018-01-26 01:11:48 +08:00
f082187844
fix(theme/book): Use passive listeners for touchstart, touchmove ( #575 )
2018-01-25 18:44:22 +08:00
bda23f0183
Missing backends are no longer fatal
2018-01-25 01:15:29 +08:00
bcfb37d964
fix(theme): Sticky header support in Safari ( #572 )
...
Safari scrolls on body, not on the html tag. It also needs sticky to be prefixed.
2018-01-23 21:13:11 +08:00
0531b585e4
fix(theme/index): Use localStorage, not store ( #574 )
...
* fix(theme/index): Use localStorage, not store
* fix(theme/index): Handle quotes values in localStorage
2018-01-23 20:30:50 +08:00
5379a0bdf8
Made the logging a lot quieter by default ( #569 )
2018-01-23 01:28:37 +08:00
0d146ffa82
Improve SUMMARY parser error messages ( fixes #566 ) ( #567 )
2018-01-22 20:47:29 +08:00
0bc3544c81
refactor: Remove store.js (use localStorage) ( #550 )
2018-01-22 07:04:16 +08:00
c89245b45b
Recursively apply replace_all() when running the links preprocessor ( #564 )
...
* Looks like we forgot to recursively apply replace_all() in #532
* Removed some print statements
* Made sure we ignore the rendered dummy_book
2018-01-22 06:44:28 +08:00
05e4157c2e
refactor(theme/book): Split into modules ( #556 )
...
Advantages:
- Easier to reason about
- Can easily disable some modules when debugging
- Shared dependencies are explicit (playpen_text)
- Enables some fancier things later one (e.g. run `codeSnippets` slightly later, to avoid blocking the page)
I'm aware that `codeSnippets` should be split into the highlighter and the editor, but I'm not sure I understand exactly how they interact so I've left it as it is for now.
2018-01-21 23:01:57 +08:00
9fe19d8f31
Increase Documentation Coverage ( #543 )
...
* Added documentation to the `config` module
* Added an example to the `config` module
* Updated the docs in lib.rs regarding implementing backends
* Started writing an alternate backends walkthrough
* Mentioned the output.foo.command key
* Added example output
* Added a config section to the backends tutorial
* Finished off the backends tutorial
* Made sure travis checks mdbook-wordcount
* Fixed the broken link at in the user guide
* Changed how travis builds the project
* Added a conclusion
* Went through and documented a lot of stuff
* Added a preprocessors chapter and updated For Developers
2018-01-21 22:35:11 +08:00
232a923676
Added a windows-specific `tee` equivalent ( #561 )
...
* Added a windows-specific `tee` equivalent
* Changed how the windows "tee" command gets quoted
* Temporarily disabled the backends_receive_render_context_via_stdin test
2018-01-20 21:46:44 +08:00
3d1a311638
refactor: Remove jQuery file ( #562 )
2018-01-20 15:56:32 +08:00
80f42675d6
feat(theme/stylus/menu): Make sticky ( #551 )
...
* feat(theme/stylus/menu): Make sticky
* feat(theme/stylus/menu): Faint bottom border
* feat(theme/book): Auto hide menu when scrolling down
* feat(theme/stylus/menu): Don't hide title
* feat(theme/stylus/menu): Only show bottom border when sticky
* fix(theme/stylus/menu): Don't hide when sidebar is expanded
* feat(theme/book): Show menu bar on hover
2018-01-19 23:41:50 +08:00
fa84da0856
Stop pulling pulldown-cmark from master ( #555 )
...
* Manually implemented PartialEq for pulldown_cmark types
* Fixed an issue where we wouldn't skip a tag properly
2018-01-19 01:21:04 +08:00
05a0d7e625
fix(theme/book): Disable stylesheets by property, not attribute
...
Closes #553 .
2018-01-18 17:12:41 +01:00
7b356b7530
Merge pull request #538 from sorin-davidoi/remove-jquery
...
Remove jQuery
2018-01-18 07:26:18 +08:00
1136f671a0
Log as each preprocessor is run
2018-01-17 19:05:15 +00:00
0d62578c7b
Make Preprocessor context store config and root
2018-01-17 09:44:52 +00:00
47cc57177d
Update comment with rustdoc link
2018-01-16 23:02:50 +00:00
90fa1b4909
Turn chained if's into match
2018-01-16 22:39:11 +00:00
f2d7b705af
Pull out default preprocessors into function
2018-01-16 22:39:11 +00:00
4177288b11
Add test to make sure pre-processors are being run
2018-01-16 22:39:11 +00:00
b599956516
Move preprocess field location and add tests
2018-01-16 22:39:11 +00:00
08027b86cc
Revert reordering
2018-01-16 22:39:11 +00:00
b98ed3f794
Clean up LinkPreprocessor exports and use explicit PreprocessorContext struct
2018-01-16 22:39:11 +00:00
9c922cf26b
Add LinkPreprocessor::new constructor
2018-01-16 22:39:11 +00:00
144358bec6
Change name of link preprocessor
2018-01-16 22:39:11 +00:00
4cc708e00f
Preprocess links by default
2018-01-16 22:39:11 +00:00
12815fe399
Add pre-processing step to build method of MDBook
2018-01-16 22:39:11 +00:00
f282a553fd
Remove unnecessary mem::replace
2018-01-16 22:39:11 +00:00
966811061b
Start determining preprocessors
2018-01-16 22:39:11 +00:00
cad76a9f6c
Factor out replace_all preprocessor
2018-01-16 22:39:11 +00:00
01df904bb3
Initial Preprocessor trait implementation
2018-01-16 22:39:11 +00:00
5a4adcce53
refactor(theme): Remove jQuery
2018-01-16 16:31:08 +01:00
be9a524eeb
Made sure the CmdRenderer always creates the destination dir
2018-01-16 21:39:59 +08:00
b0e91193e9
Meta theme color ( #547 )
...
* feat(theme/index): Add meta tag for theme-color
* feat(theme/book): Sync theme-color meta tag with the current theme
2018-01-16 20:29:20 +08:00
61fad2786b
Improve accessibility ( #535 )
...
* fix(theme/index): Use nav element for Table of Content
* fix(renderer/html_handlebars/helpers/toc): Use ol instead of ul
Chapters and sections are ordered, so we should use the appropriate HTML tag.
* fix(renderer/html_handlebars/helpers/toc): Hide section number from screen readers
Screen readers have this functionality build-in, no need to present this. Ideally, this should not even be in the DOM tree, since the numbers can be shown by using CSS.
* fix(theme/index): Remove tabIndex="-1" from .page
Divs are not focusable by default
* fix(theme): Make sidebar accessible
Using aria-hidden (together with tabIndex) takes the links out of the tab order.
http://heydonworks.com/practical_aria_examples/#progressive-collapsibles
* fix(theme/index): Wrap content inside main tag
The main tag helps users skip additional content on the page.
* fix(theme/book): Don't focus .page on page load
The main content is identified by the main tag, not by auto-focusing it on page load.
* fix(theme/index): Make page controls accessible
* fix: Make theme selector accessible
- Use ul and li (since it is a list)
- Add aria-expanded and aria-haspopup to the toggle button
- Use button instead of div (buttons are accessible by default)
- Handle Esc key (close popup)
- Adjust CSS to keep same visual style
* fix(theme/stylus/sidebar): Make link clickable area wider
Links now expand to fill the entire row.
* fix(theme): Wrap header buttons and improve animation performance
Previously, the header had a fixed height, which meant that sometimes the print button was not visible. Animating the left property is expensive, which lead to laggy animations - transform is much cheaper and has the same effect.
* fix(theme/stylus/theme-popup): Theme button inherits color
Bug introduced while making the popup accessible
* fix(theme/book): Handle edge case when toggling sidebar
Bug introduced when switching from animating left to using transform.
2018-01-15 21:26:53 +08:00
9ab54412ea
Made it so the CmdRenderer writes directly to the child's stdin ( #544 )
2018-01-14 19:14:27 +08:00
be949ceae8
Cleaned up the is_legacy_format() function
2018-01-14 04:54:11 +08:00
a1b6ccc29a
Override configuration using environment variables ( #541 )
...
* Added the ability to update config settings from env vars
* Added tests
* Documented that you can override configuration with environment
variables
* Refactored the config get() methods to use toml-query
* Made the `Updateable` trait more generic
2018-01-14 02:38:43 +08:00
e825357848
Add option to disable section label in html ( #533 )
2018-01-08 00:31:46 +08:00
fd7e8d1b7b
Add support for alternative backends ( #507 )
...
* Added a mechanism for creating alternate backends
* Added a CmdRenderer and the ability to have multiple renderers
* Made MDBook::load() autodetect renderers
* Added a couple methods to RenderContext
* Converted RenderContext.version to a String
* Made sure all alternate renderers are invoked as `mdbook-*`
* Factored out the logic for determining which renderer to use
* Added tests for renderer detection
* Made it so `mdbook test` works on the book-example again
* Updated the "For Developers" docs
* Removed `[output.epub]` from the example book's book.toml
* Added a bit more info on how backends should work
* Added a `destination` key to the RenderContext
* Altered how we wait for an alternate backend to finish
* Refactored the Renderer trait to not use MDBook and moved livereload to the template
* Moved info for developers out of the book.toml format chapter
* MOAR docs
* MDBook::build() no longer takes &mut self
* Replaced a bunch of println!()'s with proper log macros
* Cleaned up the build() method and backend discovery
* Added a couple notes and doc-comments
* Found a race condition when backends exit really quickly
* Added support for backends with arguments
* Fixed a funny doc-comment
2018-01-07 22:10:48 +08:00
dedc208a6a
Prohibit 'print.md' files ( #524 )
...
* Prohibit 'print.md' files
Fix #258 by emmiting an error whenever an mdBook contains a
"print.md" file in its root.
* Apply suggested changes
* Add tests
2018-01-07 00:02:23 +08:00
e461610dab
Implement partial include of source files ( #520 )
...
* Implement partial include of source files.
The macro `{{include some_file}}` accepts now optional line number
arguments, s.t. the specified line range is included. The following
forms are supported:
* `{{include some_file::}}` is equivalent to `{{include some_file}}`
* `{{include some_file:from:}}` includes lines [from, infinity)
* `{{include some_file::to}}` includes lines [0, to]
* `{{include some_file:from:to}}` includes lines [from, to]
* Remove the special case IncludeFull which is IncludeFrom(0).
* Use Range, RangeFrom, RangeTo and RangeFull to represent include-ranges.
Also:
* Move out introduced methods as free functions.
* Introduce RangeArgument trait as long it is unstable in stdlib.
* Use itertools for joining of lines on the fly.
* Split tests.
* Simplify include file argument parsing.
* Make utils::string private and link collections_range feature issue.
2018-01-06 05:03:30 +08:00
7c81335c9a
Use <button> for menu bar ( #523 )
2018-01-04 17:19:20 +08:00
e74c376833
You need to call `rx.iter()` to iterate over events from a channel ( #522 )
2018-01-03 19:32:49 +08:00
b5382f49c6
Merge pull request #474 from stgn/sidebar-swipe
...
Basic swipe gesture functionality for opening/closing sidebar
2018-01-02 22:10:30 +08:00
cba16a0083
Updated dependencies and made logging more readable
2017-12-30 18:43:46 +08:00
549a9ffd54
Merge pull request #470 from stgn/sidebar-page-ux
...
Improve experience on smaller screens
2017-12-30 16:15:50 +08:00
61356ce5fe
Implement playpen defaults
...
Avoids issues where we enable `editable` but forget to specify `editor`
(eg, https://github.com/rust-lang/rust-by-example/issues/963 ). Since we
already include Ace editor, seems like we can just treat it as the
default.
2017-12-21 00:18:12 -05:00
31fb443562
Cleanup and various fixes
2017-12-18 00:14:25 -05:00
a2759b7bd2
Prevent horizontal scroll on mobile browsers if page wrapper is pushed off-screen
2017-12-17 23:04:30 -05:00
71689da6b1
Force hidden sidebar on load for screen widths smaller than sidebar plus content and simplify styles
2017-12-17 23:04:30 -05:00
6e90e520d6
Avoid resizing page/content on sidebar toggle
2017-12-17 23:04:30 -05:00
65acb355d7
Merge pull request #513 from Michael-F-Bryan/error-messages
...
Added better error messages for missing CSS/JS
2017-12-14 20:28:28 +11:00
89eff2d824
Added better error messages for missing CSS/JS
2017-12-14 20:03:17 +11:00
a280a3003b
Merge pull request #447 from Listwon/clipboard
...
Fix copy to clipboard is available only for rust snippets
2017-12-13 14:32:41 +11:00
cb6f2289cf
Merge pull request #510 from Michael-F-Bryan/book-json-warning
...
Added a warning if people use the book.json config file
2017-12-13 13:18:51 +11:00
396426662d
Made `mdbook watch` and `mdbook serve` rebuild the book again ( #508 )
...
Made `mdbook watch` and `mdbook serve` rebuild the book again
2017-12-13 12:04:24 +11:00
718d251c7f
Added a warning if people use the book.json config file
2017-12-13 11:55:37 +11:00
a46e2e2b27
Merge branch 'master' into book-representation-3
2017-12-11 19:06:09 +11:00
75dac15f09
Fixed a couple issues with the docs
2017-12-11 18:50:31 +11:00
ff9e0b0add
Made sure create_missing also creates the parent directory
2017-12-11 17:29:32 +11:00
148511eceb
Able to parse all existing SUMMARY.md files
2017-12-11 17:20:05 +11:00
f5e9b857de
Rewrote summary parser from a state machine to use recursive descent
2017-12-11 15:17:20 +11:00
4f4e86db3a
Added tests to make sure we parse existing SUMMARY.md's
2017-12-11 12:26:11 +11:00
ebcf41c25b
Improved error messages using error_chain::ChainedError::display_chain()
2017-12-11 11:42:36 +11:00
1b51cd244e
Moved the book examples to the top level lib.rs
2017-12-11 11:29:30 +11:00
be4654c9c2
Fleshed out the docs for the book module
2017-12-11 11:24:43 +11:00
ace0b51fb6
Put the `create_missing` feature back in
2017-12-11 10:32:35 +11:00
9950f69c48
Removed the `MDBook::read_config()` method because it's redundant now
2017-12-10 23:13:46 +11:00
751da4f05f
Added a test to make sure you can include rust files in chapters
2017-12-10 22:59:35 +11:00
527fc5cf79
Completely removed the `create_missing` option from MDBook
2017-12-10 22:52:20 +11:00
f993677626
All tests finally pass!
2017-12-10 22:52:00 +11:00
21498631b3
Made sure the dummy book can build
2017-12-10 22:50:57 +11:00
8b21da9950
Fleshed out book creation
2017-12-10 22:50:57 +11:00
47eb4788cb
Introduced the `BookBuilder`.
...
- You now use a `BookBuilder` for creating a book directory tree
- This also removes the `--no-create` argument
2017-12-10 22:49:40 +11:00
cafb8b75e7
The library not compiles (probably completely broken)
2017-12-10 22:44:20 +11:00
4c6c696c87
Copied across the summary parser and Book structure (doesn't compile)
2017-12-10 22:43:12 +11:00
3838fa0e68
Merge pull request #501 from lifta42/master
...
Fix misplaced "previous" icon
2017-12-10 22:34:09 +11:00
8ee795045a
Added a quick fix so if the config isn't found we use a default
2017-12-09 20:36:23 +11:00
9143110a43
Optimized the stylesheet for better performance
2017-12-06 16:20:22 +08:00
e735bc6d3e
Merge pull request #500 from cspiegel/create-missing
...
WIP: Add a create-missing option to book.toml.
2017-12-06 00:30:49 +08:00
3b136689ee
Fix a CSS bug to show arrow properly
...
The arrow for "previous chapter" was on the incorrect position when screen width is between 1060px and 1250px.
2017-12-02 14:25:24 +08:00
32df76d077
Adding a header partial integration #453
2017-11-30 21:48:29 -08:00
b0b09bad3f
Clean up build configuration.
...
This rolls all "create missing" handling into BuildConfig, and moves the
build-dir option from the "book" table to the "build" table. Some
documentation cleanup surrounding the build table is also updated.
2017-11-30 07:39:58 -08:00
93874edebf
Add a create-missing option to book.toml.
2017-11-29 20:02:58 -08:00
5ce05a79be
updated links from azerupi to rust-lang-nursery ( #489 )
2017-11-22 11:35:18 +01:00
3d5eb48e32
Refactor navigation helpers ( #465 )
...
* Refactor navigation helpers
* Target::find: take previous_item by reference
This makes more sense for find as an interface, though it causes a
second clone in some cases. Maybe rustc is smart here?
* Test next and previous navigation helpers
* Add more next/previous tests
2017-11-18 19:17:26 +08:00
5eff572dbb
Updated the warning to give some basic migration instructions
2017-11-12 21:37:39 +08:00
238dfb7d1d
Added in legacy config format support
2017-11-12 21:37:38 +08:00
c25c5d72c8
Went back and simplified Config to be a smart wrapper around toml::Table
2017-11-12 21:37:38 +08:00
3aa6436679
Added in things from @Phaiax's review
2017-11-12 21:37:38 +08:00
d37821c194
Rebased after #438
2017-11-12 21:37:38 +08:00
1b5137c84e
All tests pass again :)
2017-11-12 21:37:37 +08:00
18c725ee12
Integration tests pass again
2017-11-12 21:37:37 +08:00
1743f2a39f
Removed the now redundant config files
2017-11-12 21:37:37 +08:00
cee3296a32
main library tests pass
2017-11-12 21:37:37 +08:00
ddb0834da8
Upgraded binaries to new configuration API
2017-11-12 21:37:36 +08:00
b74c2c18ef
Removed all references to old the configuration from the html renderer
2017-11-12 21:37:36 +08:00
c056b5cbd0
Removed old configs from MDBook
2017-11-12 21:37:36 +08:00
8d7970b32d
Changed to the new config types
2017-11-12 21:37:36 +08:00
1d22a9a040
Added some basic deserializing tests and helpers
2017-11-12 21:37:36 +08:00
6059883229
Added some basic configuration objects
2017-11-12 21:37:35 +08:00
8960013322
Fix copy to clipboard is available only for rust snippets
...
Fixes #432
2017-11-10 21:18:14 +01:00
79dd03e8e9
Merge pull request #471 from stgn/theme-popup-absolute
...
Use absolute positioning for theme popup
2017-11-10 13:31:12 +08:00
aecc403fb8
add tooltip to icons ( #477 )
...
add tooltip to icons and previous/next chapter links
2017-10-27 14:46:55 +02:00
6e4d2485c3
Basic swipe gesture functionality for opening/closing sidebar
2017-10-23 20:51:43 -04:00
cd711bfb1c
Merge pull request #456 from Michael-F-Bryan/conditional-ga
...
Conditional Google Analytics
2017-10-18 14:10:53 +02:00
afd9ccb7b1
Merge pull request #461 from Michael-F-Bryan/move-custom-js
...
Custom JS belongs at the bottom
2017-10-18 14:09:14 +02:00
dd3bef8000
Use absolute positioning for theme popup
2017-10-16 21:40:32 -04:00
7e5892bd35
Ignore unhelpful clippy warning
...
As discussed in https://github.com/azerupi/mdBook/pull/466
2017-10-12 22:14:48 +02:00
56cee872e8
Box Handlebars template error
...
See https://github.com/azerupi/mdBook/pull/466#issuecomment-335450110
2017-10-12 21:50:33 +02:00
a554390aa2
Slightly cleaned up the google analytics tag (skip ci)
2017-10-09 09:53:02 +08:00
8f6523a94c
Fix some clippy warnings
2017-10-07 18:11:05 +02:00
ac9c150902
Moved custom JS to the bottom
2017-10-04 19:59:10 +08:00
f2e56c887b
Got the logic around the wrong way
2017-10-04 19:57:06 +08:00
b4a12fa723
Made sure google analytics isn't included when inspecting locally
2017-10-04 19:57:06 +08:00
382fc4139b
run rustfmt on the repository #398(Updated) ( #438 )
...
rustfmt the repository #398
2017-10-03 13:40:23 +02:00
a6d4881e00
Merge pull request #450 from Zengor/master
...
Call playground with /execute
2017-09-23 21:35:41 +02:00
9b64db908f
prefix sidebar too
2017-09-22 13:58:45 -04:00
f562878131
I forgot one theme, thanks budziq
2017-09-22 13:56:58 -04:00
3823fc0e74
Call playground with /execute and not the legacy /evaluate.json
...
This commit changes the url used to call the playground, and the
request parameter format to go with it. The older evaluate is
available in the playground as a form of backwards compatibility
and swithcing now opens way for using newer features.
2017-09-21 00:24:47 -03:00
793fb8f654
Change key for theme to not clobber old books
...
Fixes https://github.com/azerupi/mdBook/issues/448
2017-09-19 16:59:16 -04:00
911683d2cf
Fix styling regression on print media in chromium
...
Forces 0px left padding on print view even if sidebar is visible
2017-09-18 22:10:31 +02:00
91fd8a2865
Fix code snippet font size a little smaller in FF
2017-09-18 11:18:21 +02:00
a3b6e549e2
Merge pull request #440 from budziq/force_runnable
...
added `mdbook-runnable` infostring support
2017-09-14 12:48:29 -04:00
c056df597a
added `mdbook-runnable` infostring support
...
makes `ignore`'d playpens runnable
2017-09-13 22:54:01 +02:00
0d6adc5fc9
Fix the issue with pages named print not at the root
2017-09-13 22:17:23 +02:00
ef5895fa78
Update all dependencies
2017-09-11 19:38:10 +02:00
84ef4d2617
preserve dashes when generating anchors and trim whitespace
2017-09-08 19:59:04 +02:00
016ec8836c
Merge pull request #415 from azerupi/fix-print-title
...
Fix the print title that was using the title from the last rendered chapter
2017-09-07 23:29:54 +02:00
881a1b39ff
Remove the logic in handlebars and expose the 3 different titles in the handlebars variables
2017-09-07 23:19:22 +02:00
a1e58229b2
Merge pull request #418 from behnam/manifest
...
[Cargo.toml] Fix package.exclude warnings
2017-09-07 22:46:49 +02:00
276eab095c
Merge pull request #427 from budziq/spurious_reloads
...
Do not trigger spurious watch events on Write and Remove
2017-09-07 22:45:12 +02:00
570ce6681f
Do not trigger spurious watch events on Write and Remove
2017-09-06 22:33:56 +02:00
ddee839d9c
[renderer] Err on bad file names, instead of panic
...
Addressing the review comments.
2017-09-06 02:25:10 -07:00
99945542ca
[renderer] Add normalize_path()
...
On the web, the normalized path separator is forward-slash (`/`), so we
use the built-in `is_separator()` method to replace any path separator
with the forward-slash, to ensure consistent output on unix and windows
machines.
2017-09-06 00:52:17 -07:00
956a5cc7fd
Fix heading links in nested pages
...
Plus fixing the whitespace chars not being replaced by hyphen.
Also expand tests for link creations, and add test for nested pages.
Fixes <https://github.com/azerupi/mdBook/issues/416 >
Fixes <https://github.com/azerupi/mdBook/issues/417 >
2017-09-06 00:52:17 -07:00
cef62ec42e
Fix build and test warnings
...
Move non-test test module files into their own directories to prevent
cargo from running them as tests. Then suppress the left-over warnings.
Move *dummy book* code and data into a shared folder, and leave the rest
of helper utilities (one function) in the original module.
2017-09-06 00:52:17 -07:00
b1362bfa06
[watch] Fix build warnings
2017-09-06 00:52:15 -07:00
6bc3039b4f
Both static and ACE editable snippets have optional play button
...
- list of available crates is dynamically loaded from play.rust-lang.org
- play button is enabled only if crates used in snippet are available on playground
- ACE editor's play button is dynamically updated on each text change
- `no_run` is honored by always disabling the play button
- minor cleanups
2017-09-06 00:18:24 +02:00
cd90fdd407
first prototype of play-button enabling only if crate list supported
...
also minor refactor of clipboard handling
TODO:
- `no_run` support
- test with ACE
- disable play button with tooltip instead of hiding
2017-09-06 00:18:24 +02:00
0a4a2b66da
Fix the print title that was using the title from the last rendered chapter. Fixes #414
2017-09-01 08:22:24 +02:00
40a4840867
[book] Prevent over-matching in gitignore rule
...
To only ignore the output destination (default: `book`) and no other
file/directory with the same name under the mdbook root, we should
prefix the gitignore rule with a leading slash (default: `/book`).
2017-08-30 16:01:45 -07:00
31983cae6c
fixed missing playpen css class when codeblock properties had whitespace
2017-08-11 12:39:27 +02:00
ddf31dcc08
Fixed `mdbook test` for {{#playpen file.rs}}
...
- now `mdbook test` does full link expansion to temp file prior to running
- also minor reformat and cleanup of `HtmlHandlebars::render_item`
2017-08-07 21:42:28 +02:00
c36eca15c2
renamed `Playpen` to `Playground` in ajax error handling
2017-08-06 17:10:52 +02:00
eed1a0a591
handle play.rust-lang.org communication errors in playpens
...
also add 15s communication timeout
2017-08-06 14:59:19 +02:00
16aa545c5b
Integrating Ace #247
2017-08-03 22:45:33 -04:00
6601dbdd61
Adding ace.js, Rust highlighter, and themes #247
2017-08-03 20:00:39 -04:00
373e36ebfb
Merge pull request #380 from ffissore/master
...
Fixed wrong filename when post processing html
2017-08-03 16:27:18 +02:00
2f8d5ce263
Removed a lot of the repetition in Theme::new()
2017-08-03 07:01:52 +08:00
ce2d7153f7
removed some repetition from the themes module
2017-08-02 23:31:37 +08:00
ee29b9d5f6
added clone derives and made the separating space mandatory in links with paths
2017-08-01 13:50:12 +02:00
d7ecb1a80c
Rewrite of {{#}} links handling in preprocess module
...
- Replaced link parser with a Regex
- Implemented {{#include}} links
- Will display relatively nice error when cannot open {{#}} linked file
- Escaped links no longer render with escape char
- utils::fs::file_to_path no takes AsRef<Path>
- sorted export/mod in lib.rs
2017-08-01 13:50:12 +02:00
f3f6b40ea9
Moved playpen.rs `renderer` helper to `preprocess/links.rs` module
2017-08-01 13:50:12 +02:00
07b80723b6
Fixed wrong filename when post processing html
2017-07-24 11:37:31 +02:00
55e7e82e5c
Merge pull request #340 from messense/feature/mdbook-test-library-path
...
Add library path argument for `mdbook test`
2017-07-08 23:27:28 +02:00
287f539b7d
Increased default logging level to info unless RUST_LOG is set
2017-06-28 23:37:03 +02:00
7c023e2d1d
Add library path argument for `mdbook test`
2017-06-28 10:33:52 +08:00
f2544e0707
Print stdout when `mdbook test` failed
2017-06-28 10:28:50 +08:00
b1ca9cf5b5
HtmlConfig is no longer optional
...
`HtmlConfig` was both guaranteed to exist within `BookConfig`
and `expect`ed in few places.
This simplifies the API a little by representing the fact that
`HtmlConfig` is currently mandatory for proper mdBook binary operation.
2017-06-27 14:01:33 +02:00
5e088d92c9
Merge remote-tracking branch 'upstream/master' into split_commands
2017-06-27 13:06:19 +02:00
b3c9ba4555
Correct clippy nits
2017-06-27 09:08:58 +02:00
7f51039f9a
Rename and move the clap sub-command generation functions
2017-06-27 07:59:50 +02:00
7799ce285e
Do not use wildcard imports if not needed
2017-06-26 23:17:46 +02:00
fe62d0c407
Merge remote-tracking branch 'upstream/master' into split_commands
2017-06-26 23:11:00 +02:00
c9a117cc4e
Merge pull request #361 from Michael-F-Bryan/error-chain
...
Add error-chain throughout the codebase
2017-06-26 17:07:51 +02:00
f3c8535870
Extracted `mdbook test` and `mdbook init` to separate files/modules
2017-06-26 01:24:33 +02:00
35ed9fc286
corrected indentation in `serve` and `watch` subcommands definitions
2017-06-26 01:22:38 +02:00
efdd0330c1
Extracted `mdbook init` to separate file/module
2017-06-26 01:02:32 +02:00
4c78fdf431
Extracted `mdbook build` to separate file/module
2017-06-26 01:00:18 +02:00
b09fdf07e4
Register `serve` and `watch` subcommands only if given features enabled
2017-06-26 00:43:28 +02:00
5c524da3c2
Extracted `mdbook watch` to separate file/module
2017-06-25 23:44:28 +02:00
99224f40d5
Extracted `mdbook serve` to separate file/module
2017-06-25 23:05:58 +02:00
83354ab24b
Fixed up some unused-imports warnings
2017-06-25 14:21:23 +08:00
f214c7108f
Make MathJax support optional
...
to enable add following to book.toml
```toml
[output.html]
mathjax-support = true
```
2017-06-25 00:32:33 +02:00
fd821a5ead
the binary now uses error-chain
2017-06-25 00:13:41 +08:00
487f5ce339
Added error-chain to the renderer module
2017-06-25 00:10:06 +08:00
1356e0f068
Added error-chain to the book and utils modules
2017-06-25 00:04:57 +08:00
0f93cd002b
Added error-chain to the config files
2017-06-24 23:53:08 +08:00
6761442241
Added error-chain to lib.rs
2017-06-24 23:48:50 +08:00
b441066105
Merge pull request #335 from Michael-F-Bryan/refactor-hbs-renderer
...
Refactor hbs renderer
2017-06-24 14:44:12 +02:00
d50486e337
Merge pull request #314 from budziq/fix_theme
...
Fixes missing the default "theme" dir location
2017-06-24 14:03:10 +02:00
c3dfabd5a2
Merge branch 'upstream/master' into refactor-hbs-renderer
...
Notably, this takes into account the curly-quotes pull request (#305 )
2017-06-24 16:07:01 +08:00
4c187bcb9f
Explained what HtmlHandlebars::write_custom_function() does
2017-06-24 15:50:51 +08:00
d42ef1cdbc
reduced code repetition in `fill_from_tomlconfig`
2017-06-23 17:01:11 +02:00
672d91e6c2
Hide theme selector popup on interaction outside of it
...
Also set cursor to pointer on theme selector items.
2017-06-23 13:31:28 +02:00
6d8ac6a23c
Fixes missing the default "theme" dir location
...
if not specified in book.toml
2017-06-23 13:29:46 +02:00
69b3e2b5cb
Merge pull request #332 from budziq/silence_404s
...
error spewing on iron 404 errors
2017-06-23 11:27:31 +02:00
5e93decf6e
Merge pull request #328 from sunng87/feature/handlebars-upgrade
...
Update handlebars and some helpers
2017-06-23 11:16:52 +02:00
79cdcb46de
extract serving code to a separate module
2017-06-23 08:59:42 +02:00
f889eb3d12
first draft of silencing 404 errors
2017-06-23 08:54:14 +02:00
3306c030e1
Merge branch 'master' of github.com:azerupi/mdBook
2017-06-23 01:10:38 +02:00
f3cb4265ca
Fix typo
2017-06-23 01:10:18 +02:00
28afebdca2
Merge branch 'minor_refactor' of https://github.com/budziq/mdBook into budziq-minor_refactor
2017-06-23 01:09:26 +02:00
ab31f4b027
Merge pull request #310 from jimmydo/ios-scroll-to-top
...
On iOS, allow scrolling to the top of the page by tapping the top of the screen
2017-06-23 01:01:19 +02:00
4128a78171
Merge branch 'master' of github.com:azerupi/mdBook
2017-06-23 00:50:11 +02:00
26fc980ffb
Remove 'curly_quotes' key from the json config
2017-06-23 00:48:59 +02:00
d252dc82d6
Merge branch 'curly-quotes' of https://github.com/jimmydo/mdBook into jimmydo-curly-quotes
2017-06-23 00:43:57 +02:00
73160877b3
Creating markdown code from playpen files instead of HTML #345
2017-06-21 09:33:41 -04:00
33f3bec301
Cleaned up the filter_map for normalizing id's using a more readable procedural style
2017-06-20 11:23:53 +08:00
8c30de16d6
Used the Entry API to make id counter incrementing nicer
2017-06-20 11:15:12 +08:00
fa95546988
Broke the header link wrapping out into smaller functions
2017-06-20 11:06:30 +08:00
ac16d7aef1
Added some tests for the original build_header_links function
2017-06-20 10:54:32 +08:00
e2a7adaa79
Introduced a RenderItemContext to make item rendering easier
...
I also accidentally ran `rustfmt` instead of `rustfmt-nightly`, so there are a lot of unnecessary style changes :(
2017-06-20 08:54:39 +08:00
75f0196c55
Pulled index rendering out into its own method
2017-06-20 07:53:46 +08:00
49336e0698
Merge branch 'master' of github.com:azerupi/mdBook
2017-06-18 19:21:08 +02:00
cff1ed5e08
remove #content
2017-06-18 19:19:48 +02:00
73c845fbbe
Merge branch 'master' of git://github.com/jmillikan/mdBook into jmillikan-master
2017-06-18 19:14:32 +02:00
193f014a5b
Add an option to convert to curly quotes when rendering to HTML
2017-06-18 10:11:04 -07:00
bd9b0d29ea
On iOS, allow scrolling to the top of the page by tapping the top of the screen
...
* This is a built-in function of iOS Safari that didn't work because the
page content was inside absolutely-positioned, scrollable divs.
* The fix is to stop using absolute positioning on `.page-wrapper` and
`.page`, so that the content uses static positioning and flows
naturally down the page.
* Consequently, `.sidebar` and `.nav-chapter` now have to use `position:
fixed` in order to be positioned relative to the viewport.
* This fix also enables Safari's built-in behavior of automatically
hiding the top and bottom toolbars when scrolling down the page.
2017-06-18 09:58:52 -07:00
4af10ce60c
Renamed a couple functions to be more descriptive and ran rustfmt
2017-06-17 21:15:54 +08:00
deab3ba751
Tiny whitespace changes
2017-06-16 06:50:13 +08:00
c1c06d6dc1
Auto focus on content to allow keyboard navigation
2017-06-15 23:15:41 +02:00
b7aa78c3c0
Minor refactoring
2017-06-15 18:39:41 +08:00
2568986fd5
fixed a typo
2017-06-15 18:17:16 +08:00
f946ef6327
Pulled some more little bits out into their own helper functions
2017-06-15 18:03:10 +08:00
0d0deb7c40
Pulled page rendering out into its own method
2017-06-15 17:43:44 +08:00
e8908e32c9
Minor cleanup
...
- removing need to explicitly use `Path::new` all over the place
- removed warnings from doctests (normally invisible unless `cargo test -- --nocapture`)
- no doctests are norun/ignore now
- updated docs both in book-example and in docs not to refer to nonexisting API's
2017-06-14 21:55:42 +02:00
ee9fa8c86f
Fix for playpen buttons missing on mobile safari and chrome IOS
2017-06-13 16:59:29 +02:00
e890579141
(fix) some merge issue
2017-06-13 20:53:25 +08:00
6ee6da074e
(refactor) rework helpers based on new handlebars api
...
Signed-off-by: Ning Sun <sunng@about.me>
2017-06-13 20:43:17 +08:00
2bb274d424
Merge branch 'master' of github.com:azerupi/mdBook
2017-06-13 20:40:46 +08:00
a6275ebcdb
copying to clipboard no longer copies the compilation results from "play"
2017-06-12 14:02:53 +02:00
9ce6eebe43
Merge branch 'master' of git://github.com/Cldfire/mdBook into Cldfire-master
2017-06-12 11:19:31 +02:00
350c86155b
Merge branch 'custom_js' of git://github.com/budziq/mdBook into budziq-custom_js
2017-06-12 11:09:07 +02:00
08fd255a56
Move from localStorage to store.js (v2.0.3)
...
Fixes a lot of browser incompatibilities in localStorage/cookie handling
Including but not limited to:
- loss of styling and functionality on chromium private mode
- loss of styling and functionality on safari and safari private mode
- awaiting verification if problems in mobile safari are solved.
2017-06-12 01:53:25 +02:00
f607978780
Hide sidebar on link selection when it occupies large space
...
in relation to the whole screen width (solves problems on phones)
2017-06-11 15:13:31 +02:00
f96e7e5cba
Implemented support for additional JS
2017-06-11 15:08:09 +02:00
56163f69f8
One more ES5 fix.
2017-06-09 22:48:57 +03:00
eba90f5440
Fix ES5 compatibility.
2017-06-09 21:59:29 +03:00
44efc65c63
Add `Ayu` theme
...
Also adds the a new variable, `$inline-code-color`, to base.styl. The `Ayu` theme needed this to change the text color of inline code.
2017-06-06 16:35:44 -04:00
f1121cf8c2
fix build failure
2017-06-04 20:47:34 +02:00
1a8e54bb52
remove unused methods
2017-06-04 20:41:31 +02:00
bb4ceb481f
Allow an additional custom stylesheets, closes #178
2017-06-04 20:41:31 +02:00
2e812db13c
Fix for google-analytics
2017-06-04 20:41:31 +02:00
70383d0a25
New config structs supports json again (the old style) for a little deprecation period
2017-06-04 20:41:31 +02:00
d3ae2eda56
Replace the old book structure with the new one
2017-06-04 20:41:31 +02:00
WofWca
Sorin Davidoi
Michael Bryan
Benoît CORTIER
Eric Huss
Ning Sun
Carol (Nichols || Goulding)
Carol (Nichols || Goulding)
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
cetra3
Lucas Morales
eyenseo
Hiroki Noda
Andrew Gauger
Mathieu David
Tim Ryan
Weihang Lo
Matt Brubeck
Gwen Lofman
Nils
Bastien Orivel
Anders Rasmussen
Guillaume Gomez
Dylan Maccora
Pawel Duzinkiewicz
Sorin Davidoi
Bulat Musin
boxdot
Jaime Valdemoros
vabc3
Jan Likar
Mario Nebl
Justin Ridgewell
Shane Nelson
lifta42
projektir
Chris Spiegel
Anna Liao
Jacob Wahlgren
Bartłomiej T. Listwon
François
Pratik Karki
Zengor
Michal Budzynski
Behnam Esfahbod
messense
Jimmy Do
Ning Sun
pravic
Cldfire