Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-14 06:42:35 +00:00
Code Issues Projects Releases Packages Wiki Activity
1087 commits 9 branches 95 tags 23 MiB
Commit graph

638 commits

Author SHA1 Message Date
Michal Budzynski
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
Mathieu David
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
Behnam Esfahbod
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
Michal Budzynski
31983cae6c fixed missing playpen css class when codeblock properties had whitespace 2017-08-11 12:39:27 +02:00
Michal Budzynski
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
Michal Budzynski
c36eca15c2 renamed Playpen to Playground in ajax error handling 2017-08-06 17:10:52 +02:00
Michal Budzynski
eed1a0a591 handle play.rust-lang.org communication errors in playpens 
also add 15s communication timeout
 2017-08-06 14:59:19 +02:00
projektir
16aa545c5b Integrating Ace #247 2017-08-03 22:45:33 -04:00
projektir
6601dbdd61 Adding ace.js, Rust highlighter, and themes #247 2017-08-03 20:00:39 -04:00
Mathieu David
373e36ebfb Merge pull request #380 from ffissore/master 
Fixed wrong filename when post processing html
 2017-08-03 16:27:18 +02:00
Michael Bryan
2f8d5ce263 Removed a lot of the repetition in Theme::new() 2017-08-03 07:01:52 +08:00
Michael Bryan
ce2d7153f7 removed some repetition from the themes module 2017-08-02 23:31:37 +08:00
Michal Budzynski
ee29b9d5f6 added clone derives and made the separating space mandatory in links with paths 2017-08-01 13:50:12 +02:00
Michal Budzynski
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
Michal Budzynski
f3f6b40ea9 Moved playpen.rs renderer helper to preprocess/links.rs module 2017-08-01 13:50:12 +02:00
Federico Fissore
07b80723b6 Fixed wrong filename when post processing html 2017-07-24 11:37:31 +02:00
Mathieu David
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
Michal Budzynski
287f539b7d Increased default logging level to info unless RUST_LOG is set 2017-06-28 23:37:03 +02:00
messense
7c023e2d1d
Add library path argument for mdbook test 2017-06-28 10:33:52 +08:00
messense
f2544e0707
Print stdout when mdbook test failed 2017-06-28 10:28:50 +08:00
Michal Budzynski
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
Michal Budzynski
5e088d92c9 Merge remote-tracking branch 'upstream/master' into split_commands 2017-06-27 13:06:19 +02:00
Michal Budzynski
b3c9ba4555 Correct clippy nits 2017-06-27 09:08:58 +02:00
Michal Budzynski
7f51039f9a Rename and move the clap sub-command generation functions 2017-06-27 07:59:50 +02:00
Michal Budzynski
7799ce285e Do not use wildcard imports if not needed 2017-06-26 23:17:46 +02:00
Michal Budzynski
fe62d0c407 Merge remote-tracking branch 'upstream/master' into split_commands 2017-06-26 23:11:00 +02:00
Mathieu David
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
Michal Budzynski
f3c8535870 Extracted mdbook test and mdbook init to separate files/modules 2017-06-26 01:24:33 +02:00
Michal Budzynski
35ed9fc286 corrected indentation in serve and watch subcommands definitions 2017-06-26 01:22:38 +02:00
Michal Budzynski
efdd0330c1 Extracted mdbook init to separate file/module 2017-06-26 01:02:32 +02:00
Michal Budzynski
4c78fdf431 Extracted mdbook build to separate file/module 2017-06-26 01:00:18 +02:00
Michal Budzynski
b09fdf07e4 Register serve and watch subcommands only if given features enabled 2017-06-26 00:43:28 +02:00
Michal Budzynski
5c524da3c2 Extracted mdbook watch to separate file/module 2017-06-25 23:44:28 +02:00
Michal Budzynski
99224f40d5 Extracted mdbook serve to separate file/module 2017-06-25 23:05:58 +02:00
Michael Bryan
83354ab24b Fixed up some unused-imports warnings 2017-06-25 14:21:23 +08:00
Michal Budzynski
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
Michael Bryan
fd821a5ead the binary now uses error-chain 2017-06-25 00:13:41 +08:00
Michael Bryan
487f5ce339 Added error-chain to the renderer module 2017-06-25 00:10:06 +08:00
Michael Bryan
1356e0f068 Added error-chain to the book and utils modules 2017-06-25 00:04:57 +08:00
Michael Bryan
0f93cd002b Added error-chain to the config files 2017-06-24 23:53:08 +08:00
Michael Bryan
6761442241 Added error-chain to lib.rs 2017-06-24 23:48:50 +08:00
Mathieu David
b441066105 Merge pull request #335 from Michael-F-Bryan/refactor-hbs-renderer 
Refactor hbs renderer
 2017-06-24 14:44:12 +02:00
Mathieu David
d50486e337 Merge pull request #314 from budziq/fix_theme 
Fixes missing the default "theme" dir location
 2017-06-24 14:03:10 +02:00
Michael Bryan
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
Michael Bryan
4c187bcb9f Explained what HtmlHandlebars::write_custom_function() does 2017-06-24 15:50:51 +08:00
Michal Budzynski
d42ef1cdbc reduced code repetition in fill_from_tomlconfig 2017-06-23 17:01:11 +02:00
Michal Budzynski
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
Michal Budzynski
6d8ac6a23c Fixes missing the default "theme" dir location 
if not specified in book.toml
 2017-06-23 13:29:46 +02:00
Mathieu David
69b3e2b5cb Merge pull request #332 from budziq/silence_404s 
error spewing on iron 404 errors
 2017-06-23 11:27:31 +02:00
Mathieu David
5e93decf6e Merge pull request #328 from sunng87/feature/handlebars-upgrade 
Update handlebars and some helpers
 2017-06-23 11:16:52 +02:00
Michal Budzynski
79cdcb46de extract serving code to a separate module 2017-06-23 08:59:42 +02:00
Michal Budzynski
f889eb3d12 first draft of silencing 404 errors 2017-06-23 08:54:14 +02:00
Mathieu David
3306c030e1 Merge branch 'master' of github.com:azerupi/mdBook 2017-06-23 01:10:38 +02:00
Mathieu David
f3cb4265ca Fix typo 2017-06-23 01:10:18 +02:00
Mathieu David
28afebdca2 Merge branch 'minor_refactor' of https://github.com/budziq/mdBook into budziq-minor_refactor 2017-06-23 01:09:26 +02:00
Mathieu David
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
Mathieu David
4128a78171 Merge branch 'master' of github.com:azerupi/mdBook 2017-06-23 00:50:11 +02:00
Mathieu David
26fc980ffb Remove 'curly_quotes' key from the json config 2017-06-23 00:48:59 +02:00
Mathieu David
d252dc82d6 Merge branch 'curly-quotes' of https://github.com/jimmydo/mdBook into jimmydo-curly-quotes 2017-06-23 00:43:57 +02:00
projektir
73160877b3 Creating markdown code from playpen files instead of HTML #345 2017-06-21 09:33:41 -04:00
Michael Bryan
33f3bec301 Cleaned up the filter_map for normalizing id's using a more readable procedural style 2017-06-20 11:23:53 +08:00
Michael Bryan
8c30de16d6 Used the Entry API to make id counter incrementing nicer 2017-06-20 11:15:12 +08:00
Michael Bryan
fa95546988 Broke the header link wrapping out into smaller functions 2017-06-20 11:06:30 +08:00
Michael Bryan
ac16d7aef1 Added some tests for the original build_header_links function 2017-06-20 10:54:32 +08:00
Michael Bryan
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
Michael Bryan
75f0196c55 Pulled index rendering out into its own method 2017-06-20 07:53:46 +08:00
Mathieu David
49336e0698 Merge branch 'master' of github.com:azerupi/mdBook 2017-06-18 19:21:08 +02:00
Mathieu David
cff1ed5e08 remove #content 2017-06-18 19:19:48 +02:00
Mathieu David
73c845fbbe Merge branch 'master' of git://github.com/jmillikan/mdBook into jmillikan-master 2017-06-18 19:14:32 +02:00
Jimmy Do
193f014a5b Add an option to convert to curly quotes when rendering to HTML 2017-06-18 10:11:04 -07:00
Jimmy Do
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
Michael Bryan
4af10ce60c Renamed a couple functions to be more descriptive and ran rustfmt 2017-06-17 21:15:54 +08:00
Michael Bryan
deab3ba751 Tiny whitespace changes 2017-06-16 06:50:13 +08:00
Michal Budzynski
c1c06d6dc1 Auto focus on content to allow keyboard navigation 2017-06-15 23:15:41 +02:00
Michael Bryan
b7aa78c3c0 Minor refactoring 2017-06-15 18:39:41 +08:00
Michael Bryan
2568986fd5 fixed a typo 2017-06-15 18:17:16 +08:00
Michael Bryan
f946ef6327 Pulled some more little bits out into their own helper functions 2017-06-15 18:03:10 +08:00
Michael Bryan
0d0deb7c40 Pulled page rendering out into its own method 2017-06-15 17:43:44 +08:00
Michal Budzynski
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
Michal Budzynski
ee9fa8c86f Fix for playpen buttons missing on mobile safari and chrome IOS 2017-06-13 16:59:29 +02:00
Ning Sun
e890579141 (fix) some merge issue 2017-06-13 20:53:25 +08:00
Ning Sun
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
Ning Sun
2bb274d424 Merge branch 'master' of github.com:azerupi/mdBook 2017-06-13 20:40:46 +08:00
Michal Budzynski
a6275ebcdb copying to clipboard no longer copies the compilation results from "play" 2017-06-12 14:02:53 +02:00
Mathieu David
9ce6eebe43 Merge branch 'master' of git://github.com/Cldfire/mdBook into Cldfire-master 2017-06-12 11:19:31 +02:00
Mathieu David
350c86155b Merge branch 'custom_js' of git://github.com/budziq/mdBook into budziq-custom_js 2017-06-12 11:09:07 +02:00
Michal Budzynski
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
Michal Budzynski
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
Michal Budzynski
f96e7e5cba Implemented support for additional JS 2017-06-11 15:08:09 +02:00
pravic
56163f69f8 One more ES5 fix. 2017-06-09 22:48:57 +03:00
pravic
eba90f5440 Fix ES5 compatibility. 2017-06-09 21:59:29 +03:00
Cldfire
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
Mathieu David
f1121cf8c2 fix build failure 2017-06-04 20:47:34 +02:00
Mathieu David
1a8e54bb52 remove unused methods 2017-06-04 20:41:31 +02:00
Mathieu David
bb4ceb481f Allow an additional custom stylesheets, closes #178 2017-06-04 20:41:31 +02:00
Mathieu David
2e812db13c Fix for google-analytics 2017-06-04 20:41:31 +02:00
Mathieu David
70383d0a25 New config structs supports json again (the old style) for a little deprecation period 2017-06-04 20:41:31 +02:00
Mathieu David
d3ae2eda56 Replace the old book structure with the new one 2017-06-04 20:41:31 +02:00
Mathieu David
170bf8b1eb New configuration struct + tests #285 2017-06-04 20:41:31 +02:00
Michal Budzynski
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
Michal Budzynski
3a809e4a1c Added local fallback for clipboard.js 2017-05-31 21:51:19 +02:00
Michal Budzynski
dfc24bec01 Fixed tooltip styling 
Also fixed problem with garbage being put in clipboard
when triggered repeatedly
 2017-05-31 21:07:47 +02:00
Michal Budzynski
e567d22f1c Initial implementation of clipboard handling 2017-05-31 19:56:17 +02:00
Michal Budzynski
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
Michal Budzynski
453b97bec0 Reformatted "Serving on " message for easier consumption 
Now we have: `Serving on: http://localhost:3000`
 2017-05-27 11:34:46 +02:00
superstring
7de24f86a9 Change --ws-port to --websocket-port 2017-05-26 19:18:32 +08:00
superstring
027c21aef7 Fix websocket port option for serve 2017-05-26 12:04:20 +08:00
aaaxx
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
Michal Budzynski
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
Michal Budzynski
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
Mathieu David
379ed9dc16 Merge pull request #284 from budziq/indentation 
Fix indentation of hidden code blocks
 2017-05-18 09:36:53 +02:00
Michal Budzynski
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
Michał Budzyński
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
Michael-F-Bryan
94dce4f796 Added google_analytics so it can be inserted into handlebars 2017-05-16 13:28:59 +08:00
Michael-F-Bryan
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
Michael-F-Bryan
4a634f08da Updated google analytics to index.hbs and hbs_renderer.rs 2017-05-16 13:05:21 +08:00
Phil Ruffwind
3066597acc Change MathJax to use CDNJS 
Because the MathJax CDN will soon be retired.
 2017-05-05 17:08:59 -04:00
Ning Sun
d1f9174e7f
(feat) adopt new handlebars navigate api 
Signed-off-by: Ning Sun <sunng@about.me>
 2017-05-05 08:41:50 +08:00
Corey Farwell
4f4120b5a4 Fix incorrect conditional. 
I accidentally introduced this in 4525810737.
 2017-04-27 09:16:19 -04:00
Corey Farwell
4525810737 Rewrite an emptiness check. 2017-04-17 21:58:34 -04:00
Corey Farwell
5d72d966ad Wrap long line. 2017-04-17 21:56:01 -04:00
Corey Farwell
15dcca87d8 Refactor to prevent excessive indentation. 2017-04-17 21:55:32 -04:00
Corey Farwell
c6e81337fb Implement new 'no-create' build flag. 
Fixes https://github.com/azerupi/mdBook/issues/253.
 2017-04-17 21:53:27 -04:00
CrazyMerlyn
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
Mathieu David
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
Vincent Esche
41735b4579 Added monospace font with support for box-drawing chars 2017-04-15 14:16:28 +02:00
Jesse Millikan
d24ad83a5c Empty header sections 2017-04-14 15:51:23 -04:00
Steve Klabnik
9cb232058b Merge pull request #243 from steveklabnik/gh241 
Accept nightly examples.
 2017-04-14 15:19:07 -04:00
mthh
df5472ab5a Should fix sections created with chapter of more than two digits 2017-04-07 12:46:28 +02:00
mthh
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
mthh
8e7ec6e1fd should fix sections created with chapter of more than two digits 2017-04-07 02:37:46 +02:00
steveklabnik
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
Tshepang Lekhonkhobe
793a88260c move misplaced example 2017-03-30 14:09:14 +02:00
Mathieu David
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
CrazyMerlyn
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
CrazyMerlyn
f814e96459 Fix keyboard navigation to trigger only if no modifier key is pressed 2017-03-23 13:29:04 +05:30
Jesse Millikan
980ea5796e next and prev attributes on the next and prev links, and #content 2017-03-19 16:21:38 -04:00
Jesse Millikan
8500d1c8a7 Relative links for non-JS browsers 2017-03-19 03:53:24 -04:00
Steve Klabnik
c6a5d12002 Merge pull request #222 from steveklabnik/gh29 
Implement playpen support for ```rust
 2017-03-10 08:59:15 -08:00
steveklabnik
b120ce7397 inject allow(unused_variables) 2017-03-10 09:46:11 -05:00
Carol (Nichols || Goulding)
56f597b90c Update to highlight.js 9.10.0 2017-03-09 22:45:59 -05:00
steveklabnik
c5f9625feb inject main 2017-03-06 13:27:25 -05:00
steveklabnik
79f00eeea3 Implement playpen support for ```rust 
Fixes #29
 2017-03-06 12:23:15 -05:00
Mathieu David
e218257e42 fix anchor links 2017-02-28 12:42:11 +01:00
Mathieu David
1345c05b18 Fix anchors, Fixes #211 2017-02-28 12:40:05 +01:00
Mathieu David
01341a7705 Fix code blocks with comma separated classes 2017-02-28 01:41:06 +01:00
Mathieu David
58cfef00f2 Merge pull request #209 from steveklabnik/gh204 
Print version: fix up header links
 2017-02-20 16:12:00 +01:00
Steve Klabnik
6af3eea24b Print version: fix up header links 2017-02-20 09:28:49 -05:00
Mathieu David
c88656284c Regenerate css 2017-02-19 11:13:19 +01:00
Corey Farwell
cfa4295d79 Bump toml crate to 0.3. 2017-02-18 20:22:55 -05:00
Mathieu David
d7f38d08fd Merge pull request #205 from frewsxcv/clippy 
Address warnings found by rust-clippy.
 2017-02-17 11:05:33 +01:00
Steve Klabnik
ec42e2f771 convert to one pass 
thanks @burntsushi ❤️
 2017-02-16 19:31:52 -05:00
Steve Klabnik
280dabecd7 update regex dep 2017-02-16 17:11:16 -05:00
Steve Klabnik
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
Steve Klabnik
d609988264 remove js rendering 2017-02-16 17:07:16 -05:00
Corey Farwell
95fd292b4f Address warnings found by rust-clippy. 
https://github.com/Manishearth/rust-clippy
 2017-02-16 16:55:28 -05:00
Corey Farwell
152ebba762 Bump serde, serde_json, and handlebars crates. 2017-02-15 23:31:05 -05:00
Pavel Ivashkov
b97a8205f6 widen hit regions of menu buttons 
![see here](http://i.imgur.com/jCZTCfr.png)
 2017-02-11 21:20:12 +02:00
Pete Hayes
4b31ae6789 Add --dest-dir arg to build, watch and serve subcommands 2017-01-12 12:26:22 +00:00
Pete Hayes
1afa2debc1 Fix spelling of omitted 2017-01-12 12:23:39 +00:00
Mathieu David
3a71371946 Merge pull request #198 from mbrubeck/watch 
Update watch command to use `notify` 3.0
 2017-01-02 19:58:47 +01:00
Matt Brubeck
c7b4147ba7 Watch both book.json and book.toml 2017-01-01 16:03:49 -08:00
Matt Brubeck
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
Matt Brubeck
09729aaca5 Clean up some Path code in bookconfig 2017-01-01 16:02:48 -08:00
Mathieu David
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
Matt Brubeck
21bc3d47c8 Add a CLI option to open a web browser 2017-01-01 09:58:20 -08:00
Matt Brubeck
f2b87f7944 Factor common io error handling out of renderer 2016-12-31 23:12:38 -08:00
Matt Brubeck
894a03655e Simplify error handling in utils::fs 2016-12-31 23:12:38 -08:00
Matt Brubeck
6b2572e78d Simplify some as_str error handling code 2016-12-31 18:41:59 -08:00
Matt Brubeck
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
Mathieu David
375502a6fa Merge pull request #194 from mbrubeck/warnings 
Fix some rustc warnings.
 2016-12-31 23:45:23 +01:00
Matt Brubeck
0f0750df52 Fix unreachable code warning in parse::summary::parse_level 2016-12-31 10:39:48 -08:00
Matt Brubeck
712adcf737 Fix cfg attribute in bookconfig_test 2016-12-31 10:36:19 -08:00
Matt Brubeck
3a0cfc87df Add current chapter title to handlebars context 2016-12-31 10:34:36 -08:00
Gambhiro
8a178e311d fix test 2016-12-24 13:44:24 +00:00
Gambhiro
53ec61ac70 upd example 2016-12-24 13:34:22 +00:00
Gambhiro
97d46e79b7 convert json to toml before config parsing 2016-12-24 13:22:01 +00:00
Gambhiro
791487bc84 parse either book.toml or book.json 2016-12-23 08:15:32 +00:00
Gambhiro
f67ae7c71a update dependency versions 2016-12-23 08:10:42 +00:00
Gambhiro
85d8e2ebd3 use theme_path key in book.json when given 2016-12-07 14:22:32 +00:00
Gambhiro
a9e5dc63f1 use src key in book.json when given 2016-12-07 09:38:56 +00:00
Mathieu David
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
Carol (Nichols || Goulding)
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
Thomas Tan
f9101ca62c Use fixed positioning and remove overflow-x's for smoother scrolling experience in iOS 2016-11-09 16:18:40 +00:00
Mathieu David
d2f3eb5007 remove unused imports 2016-11-03 02:05:35 +01:00
Mathieu David
67aee5c192 Switch from rustc_serialize to serde. Closes #18 2016-11-03 01:58:42 +01:00
Denis Kolodin
b0d33e76ec Remove unused metadata import 2016-11-01 11:19:08 +03:00
rnkaufman
2600c62cf9 Highlight js update 2016-10-27 18:26:02 -07:00
Adam Hess
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
Rodrigo Lourenço
528945d67d Copy files with no extension too. 2016-09-23 15:09:16 +01:00
Mathieu David
4852e9e65a Merge branch 'master' of https://github.com/azerupi/mdBook 2016-09-12 22:50:03 +02:00
Mathieu David
e54b6643e1 regenerate css 2016-09-12 22:43:29 +02:00
Mathieu David
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
Mathieu David
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
Boris Egorov
49608b560b Make line-height for chapter greater than section 
Fixes #166
 2016-09-04 22:04:55 +07:00
Gambhiro
4153db2624 env_logger 2016-08-14 14:55:10 +01:00
Gambhiro
db11ff27f4 use warn 2016-08-14 14:40:08 +01:00
Gambhiro
b584f6eb9c use macros from the log crate, issue #151 2016-08-14 13:34:02 +01:00
Carol (Nichols || Goulding)
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
Ferris
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
Mathieu David
5350d62591 Update all dependencies to latest version 2016-08-01 14:06:08 +02:00
icanrealizeum
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
Ian Thompson
b0e5f375ba Make sure <ul><li> and </li></ul> are balanced 2016-07-16 10:23:22 -04:00
Onur Aslan
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
Austin Hartzheim
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
Boris-Chengbiao Zhou
dfef0d7585 Add print media query 2016-06-10 19:30:26 +02:00
Boris-Chengbiao Zhou
9b1e224680 Fix no-default-features build 2016-05-08 21:51:34 +02:00
Boris-Chengbiao Zhou
e3f398cff2 Add address output to mdbook serve 2016-04-27 22:29:48 +02:00
Mathieu David
6bc088db6e (Refactor) Move the Render trait into mod.rs instead of submodule 2016-04-27 14:19:59 +02:00
Mathieu David
e34bef0e53 (Refactor) Move mdbook.rs to mod.rs 2016-04-26 23:04:27 +02:00
Mathieu David
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
Mathieu David
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
Mathieu David
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
Mathieu David
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
Boris-Chengbiao Zhou
c8051294b0 Switch from rust-websocket to ws-rs 2016-04-02 21:44:13 +02:00
Boris-Chengbiao Zhou
e861880f95 Implement Serve feature 2016-04-02 05:20:46 +02:00
Mathieu David
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
Mathieu David
15d26befcc Refactor: Move extern crate definitions to lib.rs 2016-03-27 18:22:17 +02:00
Lucio Franco
ceb139a848 Moved CDN's to https 2016-03-23 14:16:41 -06:00
Mathieu David
c5752620d7 Merge pull request #122 from Bobo1239/fix_cooldown 
Fix watch event cooldown
 2016-03-19 19:40:58 +01:00
Boris Zhou
7f3a6c8130 Fix watch event cooldown 2016-03-19 18:28:34 +01:00
Boris-Chengbiao Zhou
b30a8bdc81 Update dependencies 2016-03-19 17:45:58 +01:00
Mathieu David
74fff81e4b Refactor: Move fs related functions from utils into their own submodule 2016-03-17 22:41:00 +01:00
Mathieu David
ad0794a0bd Add a rustfmt config and run rustfmt on the code base 2016-03-17 22:31:28 +01:00
vrinek
bc41efe414 Move .gitignore directly under the root folder 2016-03-07 08:52:19 +00:00
Mathieu David
5316089e61 Modify wording of confirmation request before creation of .gitignore 2016-03-02 19:38:39 +01:00
Mathieu David
73ce3f814a Merge branch 'init-with-gitignore' of https://github.com/vrinek/mdBook into vrinek-init-with-gitignore 2016-03-02 19:20:21 +01:00
vrinek
1eb59428e6 Ask user to create .gitignore and skip on --force 2016-02-28 15:28:11 +00:00
Jesse Stricker
330b1ad55d Add description config option 2016-02-25 14:32:49 +01:00
vrinek
596455f28c Generate simple .gitignore on init 2016-02-23 14:03:45 +00:00
Jesse Stricker
88fabd76f0 Copy favicon on 'init --theme' 2016-02-22 17:20:54 +01:00
Jesse Stricker
f508db6113 Add favicon support to theme 2016-02-22 17:17:07 +01:00
Jesse Stricker
1083d1822d Add default favicon.png 2016-02-22 16:59:53 +01:00
funkill
f2b913c9dd add rounding for first and last items in theme selector 2016-02-16 11:15:08 +03:00
Mathieu David
5891e4b5db Fix bug where theme-popup was under the navigation arrows making it impossible to change the theme 2016-02-16 08:50:57 +01:00
Mathieu David
7364d41f0c Style tables, different header bg, alternate row color and border 2016-02-05 18:09:35 +01:00
Mathieu David
0b00c270d5 Fix a style bug caused by the insertion of the theme-popup div inside font awesome icon <i> 
The div is now inserted after the <i>, the text color has also been changed to the foreground color and the "(default)" text that indicates the default theme is now grey to contrast with the theme name

Fixes #97
 2016-02-03 17:55:19 +01:00
Mathieu David
3fd1d4606c Fix tests after removing PathExt from utils 2016-01-03 14:08:17 +01:00
Mathieu David
78b6148463 Basic formatting for tables + Styling for blockquotes 
Added basic formatting for tables so that they have some padding and are aligned in the center of the page.
I did not add color or borders because I am not sure how tables should look like.

A lot of people in IntermezzOS want asides, blockquotes are probably the easiest way to do that. I have thus styled blockquotes for all the color themes.
 2016-01-03 13:47:59 +01:00
Mathieu David
78e1897b47 Remove code that has better equivalent in std 
Path_Ext has been stabilized in the Standard Library, the temporary copy I had can go.

I found a fs::create_dir_all method that does exactly what create_path was doing, but better... create_path is thus replaced with that.
 2016-01-03 13:02:04 +01:00
Mathieu David
d000fc8bac Updated pulldown-cmark to version 0.0.5 
Version 0.0.5 contains table and footnotes support, both options are now enabled in mdBook.
 2016-01-03 12:02:39 +01:00
Mathieu David
5170e6b675 Fix #89, bug introduced earlier where all headers are black in all color themes 2016-01-01 11:02:24 +01:00
Mathieu David
a7f329d337 Add href to heading anchors so that the url for the anchor is displayed in the url bar when clicking the header 2016-01-01 02:17:40 +01:00
Mathieu David
2a7463c45b #29 Add a way to escape {{#playpen ... } using a backslash in front: \{{#playpen ... }} 2016-01-01 01:40:37 +01:00
Mathieu David
db7424e947 Continue #29, playpens are now runnable 2016-01-01 00:32:12 +01:00
Mathieu David
0ac0301d72 Continue #29, Rust files can now be loaded with {{#playpen file.rs}}, they will be displayed as other code snippets included with markdown backticks except they have a playpen css class 2015-12-31 19:25:02 +01:00
Mathieu David
38b2dee17e Continue #29 Check that the rust file exists and read to string 2015-12-31 14:14:56 +01:00
Mathieu David
0cb234de5d Add tests for find_playpens 2015-12-31 12:02:25 +01:00
Mathieu David
ee4a7fb35c Start implementing #29 support for embedding playpen, implemented the function that parses the markdown to find playpen links 2015-12-30 22:40:23 +01:00
Mathieu David
ae6334f358 Fix bug where we would not check if there was actually a page to navigate to when using arrow keys 2015-12-30 17:19:43 +01:00
Mathieu David
600eb02fee Fix bug introduced earlier, where navigation arrows would become blue when visited + make the tooltip on nvigation arrows a little clearer 2015-12-30 16:48:46 +01:00
Mathieu David
41462e8b2d Merge pull request #87 from funkill/keys_navigation 
add navigation by arrows
 2015-12-30 16:37:09 +01:00
Istratov D. S
43eef7637a add navigation by arrows 2015-12-30 18:30:08 +03:00
Mathieu David
dc8f6cd5e9 Add contributors to the doc + set visisted links to the same color as normal links 2015-12-30 15:59:18 +01:00
Mathieu David
5b9d8ee6ac Fix #83, spacing is reduced between two consecutive headings 2015-12-30 15:41:49 +01:00
Mathieu David
2d00f40a24 Tweak css for inline code blocks in sidebar 2015-12-30 00:50:22 +01:00
Mathieu David
e40b293336 Fix #70 render inline code blocks in the sidebar 2015-12-30 00:46:55 +01:00
Mathieu David
b40688c880 Merge branch 'master' into watch-command 2015-12-29 13:40:13 +01:00
Mathieu David
71213f40da Add expand/collapse button to show and hide the hidden code lines 2015-12-29 13:08:25 +01:00
Mathieu David
0620ef1f47 Hides rust code lines prepended with # 2015-12-29 12:26:32 +01:00
Mathieu David
d6d0979ecf The code on the lines prepended with a # are hidden, the space of the line remains because of the '\n' in <pre> tag 2015-12-28 23:52:05 +01:00
Mathieu David
159b300067 Merge branch 'master' into hide-rust-js 2015-12-28 16:40:56 +01:00
Mathieu David
0dd6a17187 Fix some small things in javascript 2015-12-28 16:39:14 +01:00
Mathieu David
f9b6e09c26 Merge pull request #79 from asolove/72-auto-anchor 
Add anchors around all headers in the content.
 2015-12-28 16:29:55 +01:00
asolove
4dfa15cffa Update .styl file. Ran the compile and it results in exactly what I did by hand, d'oh. 2015-12-27 21:13:31 -07:00
asolove
0ab8a73ba2 Add anchors around all headers in the content. 
- Just uses the header's text as its anchor name. Spaces work. Scrolling to the anchor works even when the anchor is added after the dom loads.
- Adjust theme css to only style links, not <a> tags used as anchors.
 2015-12-27 15:17:59 -07:00
asolove
5b289c1303 Fix 0ffd638 with smarter way to join with linebreaks. 2015-12-27 14:24:42 -07:00
asolove
0ffd638904 Add newlines back in to generated index.html files. 2015-12-27 14:10:13 -07:00
asolove
1de00f9cd7 On page load, scroll sidebar to active section. 2015-12-26 20:45:50 -07:00
mdinger
b1265862c7 Generalize inline code to all themes 2015-12-22 16:30:05 -05:00
Mathieu David
f1cd9f54c2 Fixes rust-lang/book#29 where the navigation arrow for next chapter was displayed on top of the scroll bar making it unusable 2015-12-17 17:34:24 +01:00
Steve Klabnik
6bcc592ed9 Implement 'mdbook test' 
Fixes #69
 2015-12-15 13:56:24 -05:00
Mathieu David
4ca6693a48 Update handlebars from 0.11.x to 0.12.x 2015-12-15 18:58:34 +01:00
Mathieu David
22b6448381 Merge branch 'master' into watch-command 2015-11-10 16:33:25 +01:00
Mathieu David
6dcb411f6a Bumped version that was still set to 0.0.1 + added a bigger top margin for h2 and h3 elements 2015-11-10 16:26:39 +01:00
Mathieu David
cdbb2ee5fd Watch builds are now spawned in new threads (using crossbeam) and there is a timelock, preventing multiple builds being triggered in less than a second 2015-11-09 14:31:00 +01:00
Mathieu David
522eef9296 first implementation of the watch sub-command. #61 Needs refining, bug in notify made me use recursion, afraid of hitting the max recursion limit... 2015-09-27 14:38:37 +02:00
Mathieu David
c1c1074292 Fix back-button cache problem? #59 2015-09-24 22:33:05 +02:00
Mathieu David
9a43f9ff8c Fix typo in the css classes 2015-09-24 20:56:16 +02:00
Mathieu David
6c240090ae Fix #47 sidebar stays hidden even after page change 2015-09-24 16:47:33 +02:00
Mathieu David
7446743cd6 Merge branch 'css-to-stylus' 2015-09-24 15:54:48 +02:00
Mathieu David
a177a9e10d Only regenerate css when feature regenerate-css is enabled 2015-09-24 15:37:20 +02:00
Mathieu David
efc0f40466 Fix low contrast in mobile nav buttons #57 2015-09-24 00:19:43 +02:00
Mathieu David
bd99a4382f Converted all css to stylus 2015-09-18 22:13:55 +02:00
Mathieu David
5dfe477cd1 Should fix #56 2015-09-18 16:18:37 +02:00
Mathieu David
c725df3edd Add test and closes #55 2015-09-18 16:12:43 +02:00
Mathieu David
0a50d6b33f Fixed the error in copy_files_except_ext #55 2015-09-18 15:28:58 +02:00
Mathieu David
e377f4702f Preliminary setup for switching from pure css to stylus 2015-09-18 14:46:55 +02:00
Mathieu David
103048c0d1 Merge branch 'master' of https://github.com/azerupi/mdBook 2015-09-17 19:45:36 +02:00
Mathieu David
b7bcf2e246 Files other than .md are now copied to the output dir Fixes #52 + Added max-width in css for images 2015-09-17 19:45:06 +02:00
mdinger
b164e0709b Fix many minor warnings found by clippy 2015-09-16 22:48:01 -04:00
Mathieu David
5960050676 Added my first test!! :) For copy_files_except_ext function 2015-09-16 23:39:00 +02:00
Mathieu David
1799ed9ed3 Added utility function to copy all files recursively except files that have an extension present in the ext_blacklist parameter 2015-09-16 19:01:53 +02:00
Mathieu David
f3cf63c4ec (Re)add greyed sidebar elements for links that do not exist for all themes 2015-09-14 19:20:51 +02:00
Mathieu David
5f125bd30e Improve the color of the spacer for the rust, coal and navy theme 2015-09-14 18:29:03 +02:00
Mathieu David
54a56a6354 Fix flash when selecting another theme and reloading the page 2015-09-14 18:12:45 +02:00
Mathieu David
195bfd2f7f Merge pull request #48 from mdinger/dark_theme 
Multiple themes
 2015-09-14 17:49:29 +02:00
Mathieu David
5a3155aba7 Fix #50 base url sometimes not correct for index.html 2015-09-14 17:45:30 +02:00
mdinger
3dc8ff5e62 Add a rust theme 2015-09-14 05:25:42 -04:00
mdinger
937cd36b96 Nit: remove duplicate color 2015-09-14 05:10:14 -04:00