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
170bf8b1eb
New configuration struct + tests #285
2017-06-04 20:41:31 +02:00
be3418a269
Now changes to `theme` directory trigger rebuild for `mdbook serve`
...
As `theme` dir is no longer under `src`. Updates to "theme" did not
trigger book rebuild.
Also fixed misleading docs about `theme` dir being located in `src`
2017-06-01 13:11:39 +02:00
3a809e4a1c
Added local fallback for clipboard.js
2017-05-31 21:51:19 +02:00
dfc24bec01
Fixed tooltip styling
...
Also fixed problem with garbage being put in clipboard
when triggered repeatedly
2017-05-31 21:07:47 +02:00
e567d22f1c
Initial implementation of clipboard handling
2017-05-31 19:56:17 +02:00
8bfcd9939c
Updated highlight.js to v9.12.0
...
Fixing problem with raw strings syntax highlighting
Also backported updates to atelier-dune-light.css
2017-05-31 15:12:20 +02:00
453b97bec0
Reformatted "Serving on " message for easier consumption
...
Now we have: `Serving on: http://localhost:3000 `
2017-05-27 11:34:46 +02:00
7de24f86a9
Change --ws-port to --websocket-port
2017-05-26 19:18:32 +08:00
027c21aef7
Fix websocket port option for serve
2017-05-26 12:04:20 +08:00
cc1cb9edb0
CSS: better fallback stack for monospaced fonts
...
List of system fonts (R, I, B means roman, italic and bold. Ubuntu probably comes with more fonts, but I couldn't find a list to confirm.):
```txt
Windows
----------
Consolas R RI B BI
Courier R
Courier New R RI B BI
Lucida Console R
Mac
----------
Andale Mono R
Courier R RI B BI
Courier New R RI B BI
Menlo R RI B BI
Monaco R
Ubuntu
----------
Ubuntu Mono R RI B BI
DejaVu Sans Mono R RI B BI
```
```css
font-family: Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
```
Consolas and Ubuntu are professionally designed fonts ([Lucas de Groot][1] and [Dalton Maag][2]), with true, calligraphic italic, so they go at the top of the stack.
Menlo is [based on DejaVu Sans Mono][3], the only difference being a few tweaked glyphs, so DejaVu serves as a fallback for it.
As for Courier New, other than being unreadably spindly, it's the default monospaced font in all browsers, so there's no need to include it in the stack.
The `monospace, monospace;` declaration is, by now, [a standard hack][4] that overrides some browsers' behaviour of defaulting the `monospace` elements to smaller font size. Without it, any relative font size you apply to them will be calculated from that reduced size (seems to be 13 px in all browsers).
[1]: https://en.wikipedia.org/wiki/Luc(as)_de_Groot
[2]: https://en.wikipedia.org/wiki/Dalton_Maag
[3]: http://www.leancrew.com/all-this/2009/10/the-compleat-menlovera-sans-comparison/
[4]: https://stackoverflow.com/questions/38781089/font-family-monospace-monospace
2017-05-24 06:07:58 +02:00
9c8c819ec3
Inline code with hyperlink is now highlighted
...
Inline code with hyperlink has now a different color then
standard inline code and has a on hover underline.
2017-05-20 17:10:53 +02:00
75bbd55128
Changes made with rustfmt including `use_try_shorthand`
...
Updated the project rustfmt.toml to include `use_try_shorthand = true`.
Run rustfmt on all rust sources.
2017-05-19 13:04:37 +02:00
379ed9dc16
Merge pull request #284 from budziq/indentation
...
Fix indentation of hidden code blocks
2017-05-18 09:36:53 +02:00
e4dd03c8f0
Fix indentation of hidden code blocks
...
Hidden code blocks are no longer indented with
one additional space (required for doctests to compile in some cases)
Now the behavior is similar to the rustdoc's
2017-05-18 00:04:09 +02:00
c99ce06370
Do not add playpen boilerplate quick_main! is used
...
code snippets using quick_main! macro from error-chain
https://docs.rs/error-chain/0.10.0/error_chain/macro.quick_main.html
no longer have `fn main` implicitly added
2017-05-17 22:27:03 +02:00
94dce4f796
Added google_analytics so it can be inserted into handlebars
2017-05-16 13:28:59 +08:00
ada1f29b34
Added a google_analytics field to BookConfig
...
This commit:
- Adds an Option<String> field to the BookConfig which should
contain your google analytics ID
- Allows the google analytics ID to be extracted from the config
file (key is google_analytics_id)
- Adds a test to make sure the field is populated from a config
file correctly
2017-05-16 13:15:04 +08:00
4a634f08da
Updated google analytics to index.hbs and hbs_renderer.rs
2017-05-16 13:05:21 +08:00
3066597acc
Change MathJax to use CDNJS
...
Because the MathJax CDN will soon be retired.
2017-05-05 17:08:59 -04:00
d1f9174e7f
(feat) adopt new handlebars navigate api
...
Signed-off-by: Ning Sun <sunng@about.me>
2017-05-05 08:41:50 +08:00
4f4120b5a4
Fix incorrect conditional.
...
I accidentally introduced this in 4525810737
2017-04-27 09:16:19 -04:00
4525810737
Rewrite an emptiness check.
2017-04-17 21:58:34 -04:00
5d72d966ad
Wrap long line.
2017-04-17 21:56:01 -04:00
15dcca87d8
Refactor to prevent excessive indentation.
2017-04-17 21:55:32 -04:00
c6e81337fb
Implement new 'no-create' build flag.
...
Fixes https://github.com/azerupi/mdBook/issues/253 .
2017-04-17 21:53:27 -04:00
65d7e86024
Remove the extra run button on runnable rust files
...
The playpen helper now uses a simple pre block instead of a pre block
with class playpen as it led to nested playpens.
2017-04-16 18:17:59 +05:30
b5ec813d2f
Merge pull request #250 from regexident/master
...
Added monospace font with support for box-drawing chars
2017-04-15 20:37:17 +02:00
41735b4579
Added monospace font with support for box-drawing chars
2017-04-15 14:16:28 +02:00
d24ad83a5c
Empty header sections
2017-04-14 15:51:23 -04:00
9cb232058b
Merge pull request #243 from steveklabnik/gh241
...
Accept nightly examples.
2017-04-14 15:19:07 -04:00
df5472ab5a
Should fix sections created with chapter of more than two digits
2017-04-07 12:46:28 +02:00
d768963c30
Revert "should fix sections created with chapter of more than two digits"
...
This reverts commit 8e7ec6e1fd
2017-04-07 10:47:45 +02:00
8e7ec6e1fd
should fix sections created with chapter of more than two digits
2017-04-07 02:37:46 +02:00
80f01d70c6
Accept nightly examples.
...
This also brings us to parity with rustdoc regarding attributes in
general; while this PR was focused on enabling nightly, that was a
happy accident.
2017-03-31 17:06:03 -04:00
793a88260c
move misplaced example
2017-03-30 14:09:14 +02:00
1632d2e339
Merge pull request #230 from crazymerlyn/ignore_arrow_keys_with_modifier
...
Fix keyboard navigation to trigger only if no modifier key is pressed
2017-03-26 18:49:27 +02:00
ed1a216121
Fix header links
...
Header fragment links now use "id" attribute instead of the depreciated
"name" attribute.
Similar headers are given numbered ids to avoid id collisions.
For instance, if there are three headers named "Example", their ids
would be "#example", "#example-1", and "#example-2" respectively.
2017-03-23 23:24:26 +05:30
f814e96459
Fix keyboard navigation to trigger only if no modifier key is pressed
2017-03-23 13:29:04 +05:30
980ea5796e
next and prev attributes on the next and prev links, and #content
2017-03-19 16:21:38 -04:00
8500d1c8a7
Relative links for non-JS browsers
2017-03-19 03:53:24 -04:00
c6a5d12002
Merge pull request #222 from steveklabnik/gh29
...
Implement playpen support for ```rust
2017-03-10 08:59:15 -08:00
b120ce7397
inject allow(unused_variables)
2017-03-10 09:46:11 -05:00
56f597b90c
Update to highlight.js 9.10.0
2017-03-09 22:45:59 -05:00
c5f9625feb
inject main
2017-03-06 13:27:25 -05:00
79f00eeea3
Implement playpen support for ```rust
...
Fixes #29
2017-03-06 12:23:15 -05:00
e218257e42
fix anchor links
2017-02-28 12:42:11 +01:00
1345c05b18
Fix anchors, Fixes #211
2017-02-28 12:40:05 +01:00
01341a7705
Fix code blocks with comma separated classes
2017-02-28 01:41:06 +01:00
58cfef00f2
Merge pull request #209 from steveklabnik/gh204
...
Print version: fix up header links
2017-02-20 16:12:00 +01:00
6af3eea24b
Print version: fix up header links
2017-02-20 09:28:49 -05:00
c88656284c
Regenerate css
2017-02-19 11:13:19 +01:00
cfa4295d79
Bump toml crate to 0.3.
2017-02-18 20:22:55 -05:00
d7f38d08fd
Merge pull request #205 from frewsxcv/clippy
...
Address warnings found by rust-clippy.
2017-02-17 11:05:33 +01:00
ec42e2f771
convert to one pass
...
thanks @burntsushi ❤️
2017-02-16 19:31:52 -05:00
280dabecd7
update regex dep
2017-02-16 17:11:16 -05:00
38b3516b60
Implement links in section headers.
...
This project already had a transitive dependency on regex; let's use it.
This isn't the most efficient solution, but it should be fine. It ends
up doing five full scans of the text. There's probably an easier way but
I'm mostly just trying to get this to work for now.
This also implements the same algorithm that rustdoc does for generating
the name for the link.
Fixes #204
2017-02-16 17:07:17 -05:00
d609988264
remove js rendering
2017-02-16 17:07:16 -05:00
95fd292b4f
Address warnings found by rust-clippy.
...
https://github.com/Manishearth/rust-clippy
2017-02-16 16:55:28 -05:00
152ebba762
Bump serde, serde_json, and handlebars crates.
2017-02-15 23:31:05 -05:00
b97a8205f6
widen hit regions of menu buttons
...
2017-02-11 21:20:12 +02:00
4b31ae6789
Add --dest-dir arg to build, watch and serve subcommands
2017-01-12 12:26:22 +00:00
1afa2debc1
Fix spelling of omitted
2017-01-12 12:23:39 +00:00
3a71371946
Merge pull request #198 from mbrubeck/watch
...
Update watch command to use `notify` 3.0
2017-01-02 19:58:47 +01:00
c7b4147ba7
Watch both book.json and book.toml
2017-01-01 16:03:49 -08:00
1ac2602360
Update to notify 3.0
...
notify now does its own event debouncing, so it's no longer necessary
for mdbook to do this manually.
2017-01-01 16:03:49 -08:00
09729aaca5
Clean up some Path code in bookconfig
2017-01-01 16:02:48 -08:00
3ffd24df63
Merge pull request #196 from mbrubeck/open
...
Add a CLI option to open a web browser
2017-01-01 19:22:55 +01:00
21bc3d47c8
Add a CLI option to open a web browser
2017-01-01 09:58:20 -08:00
f2b87f7944
Factor common io error handling out of renderer
2016-12-31 23:12:38 -08:00
894a03655e
Simplify error handling in utils::fs
2016-12-31 23:12:38 -08:00
6b2572e78d
Simplify some as_str error handling code
2016-12-31 18:41:59 -08:00
fe287a1eca
Code cleanup: Remove unnecessary .remove() calls
...
`BTreeMap::insert` will replace any existing value, so there's no need
to remove the old value first.
2016-12-31 18:33:17 -08:00
375502a6fa
Merge pull request #194 from mbrubeck/warnings
...
Fix some rustc warnings.
2016-12-31 23:45:23 +01:00
0f0750df52
Fix unreachable code warning in parse::summary::parse_level
2016-12-31 10:39:48 -08:00
712adcf737
Fix cfg attribute in bookconfig_test
2016-12-31 10:36:19 -08:00
3a0cfc87df
Add current chapter title to handlebars context
2016-12-31 10:34:36 -08:00
8a178e311d
fix test
2016-12-24 13:44:24 +00:00
53ec61ac70
upd example
2016-12-24 13:34:22 +00:00
97d46e79b7
convert json to toml before config parsing
2016-12-24 13:22:01 +00:00
791487bc84
parse either book.toml or book.json
2016-12-23 08:15:32 +00:00
f67ae7c71a
update dependency versions
2016-12-23 08:10:42 +00:00
85d8e2ebd3
use theme_path key in book.json when given
2016-12-07 14:22:32 +00:00
a9e5dc63f1
use src key in book.json when given
2016-12-07 09:38:56 +00:00
cf35e08abc
Merge pull request #181 from thomastanck/master
...
Use fixed positioning and remove overflow-x's for smoother scrolling …
2016-11-22 10:06:41 +01:00
08b5d14f7e
Add hljs class to all code blocks, regardless of highlighting
...
Fixes #179 .
Highlight.js does not apply syntax highlighting to code blocks marked
no-highlight, nohighlight, plain, or text. When it finds blocks of those
languages, it does not add the `hljs` class to those code blocks either.
highlight.css and tomorrow-night.css use the `hljs` class to give code
blocks their backrgound color and text color, and we want that to apply
even if the code doesn't get syntax highlighting markup.
This is a somewhat hacky solution to get just that behavior! After this
commit, code blocks with no-highlight, nohighlight, plain, or text
language set on them will indeed get the hljs colors.
2016-11-13 21:14:00 -05:00
f9101ca62c
Use fixed positioning and remove overflow-x's for smoother scrolling experience in iOS
2016-11-09 16:18:40 +00:00
d2f3eb5007
remove unused imports
2016-11-03 02:05:35 +01:00
67aee5c192
Switch from rustc_serialize to serde. Closes #18
2016-11-03 01:58:42 +01:00
b0d33e76ec
Remove unused metadata import
2016-11-01 11:19:08 +03:00
2600c62cf9
Highlight js update
2016-10-27 18:26:02 -07:00
f26f41fde3
slugify section headers
...
The current section headers are url encoded. Because of that they
have some funny characters like %20. We can clean that up by removing
all of the non-word characters before placing them in the anchor.
2016-10-20 22:02:16 -07:00
528945d67d
Copy files with no extension too.
2016-09-23 15:09:16 +01:00
4852e9e65a
Merge branch 'master' of https://github.com/azerupi/mdBook
2016-09-12 22:50:03 +02:00
e54b6643e1
regenerate css
2016-09-12 22:43:29 +02:00
c7a95ccb8b
Fix round corners in theme selector, changes were previously comitted directly to the css file causing them to be overwritten
2016-09-12 22:19:36 +02:00
81a8f946b7
Fix print.styl, changes were previously comitted directly to the css file causing them to be overwritten
2016-09-12 22:10:33 +02:00
49608b560b
Make line-height for chapter greater than section
...
Fixes #166
2016-09-04 22:04:55 +07:00
4153db2624
env_logger
2016-08-14 14:55:10 +01:00
db11ff27f4
use warn
2016-08-14 14:40:08 +01:00
b584f6eb9c
use macros from the log crate, issue #151
2016-08-14 13:34:02 +01:00
a459a3606e
Exit with a nonzero status if we get an error
...
This is especially important when mdbook is used with CI.
2016-08-06 14:54:07 -04:00
317023cd0e
Added option to configure serve interface and address browser will use to connect to websocket server.
2016-08-05 21:40:00 +00:00
5350d62591
Update all dependencies to latest version
2016-08-01 14:06:08 +02:00
b4948b680f
Fixes #156 - anchors are now URI encoded
...
also fixes https://github.com/rust-lang/book/issues/166 anchors duplication
Thanks @azerupi for mentoring in #156 !
Cheers!
2016-07-31 15:21:58 +03:00
b0e5f375ba
Make sure <ul><li> and </li></ul> are balanced
2016-07-16 10:23:22 -04:00
b9e22bb8f2
Use light theme when javascript is disabled
...
mdBook is setting theme (by adding a class attribute to body tag) with javascript.
Page is not using any theme by default and page is not using any styling unless
javascript is enabled.
This patch is adding class attribute to body tag and making mdBook to use `light`
theme when javascript is disabled.
Fixes : #144
2016-06-15 17:25:28 +03:00
03373c6bf2
Fix azerupi/mdBook#133 by adding a link to the GitHub repo at the end of the --help output.
2016-06-11 23:08:48 +00:00
dfef0d7585
Add print media query
2016-06-10 19:30:26 +02:00
9b1e224680
Fix no-default-features build
2016-05-08 21:51:34 +02:00
e3f398cff2
Add address output to mdbook serve
2016-04-27 22:29:48 +02:00
6bc088db6e
(Refactor) Move the Render trait into mod.rs instead of submodule
2016-04-27 14:19:59 +02:00
e34bef0e53
(Refactor) Move mdbook.rs to mod.rs
2016-04-26 23:04:27 +02:00
15d6227a11
Attempt to fix #119 replace `\` with `/` in paths, so that Windows also uses `/` as separator (ugly hack)
2016-04-25 17:02:47 +02:00
1b8af2bf57
Fix #120 destination and source directories can now be constructed correctly even if multiple directories do not exist on the path
2016-04-25 15:58:44 +02:00
876ea7895a
Fix #131 where src and dest paths were not prefixed with the root directory if it was not the current directory
2016-04-25 15:50:34 +02:00
2ec5648587
Remove BookConfig field from MDBook
...
MDBook now stores the necessary information, BookConfig is not used as a field anymore. It is only used for parsing the configuration file. This allows to more easily replace the book.json config with the new tomlbased config
2016-04-05 12:44:14 +02:00
c8051294b0
Switch from rust-websocket to ws-rs
2016-04-02 21:44:13 +02:00
e861880f95
Implement Serve feature
2016-04-02 05:20:46 +02:00
c3564f1699
Add convenience function to read the content from a file into a string given a path
2016-03-27 18:40:50 +02:00
15d26befcc
Refactor: Move extern crate definitions to lib.rs
2016-03-27 18:22:17 +02:00
Mathieu David
Jimmy Do
Michael Bryan
Michal Budzynski
Ning Sun
pravic
Cldfire
superstring
aaaxx
Phil Ruffwind
Corey Farwell
CrazyMerlyn
Vincent Esche
Jesse Millikan
Steve Klabnik
mthh
mthh
Tshepang Lekhonkhobe
Carol (Nichols || Goulding)
Pavel Ivashkov
Pete Hayes
Matt Brubeck
Gambhiro
Thomas Tan
Denis Kolodin
rnkaufman
Adam Hess
Rodrigo Lourenço
Boris Egorov
Ferris
icanrealizeum
Ian Thompson
Onur Aslan
Austin Hartzheim
Boris-Chengbiao Zhou
