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
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
ceb139a848
Moved CDN's to https
2016-03-23 14:16:41 -06:00
c5752620d7
Merge pull request #122 from Bobo1239/fix_cooldown
...
Fix watch event cooldown
2016-03-19 19:40:58 +01:00
7f3a6c8130
Fix watch event cooldown
2016-03-19 18:28:34 +01:00
b30a8bdc81
Update dependencies
2016-03-19 17:45:58 +01:00
74fff81e4b
Refactor: Move fs related functions from utils into their own submodule
2016-03-17 22:41:00 +01:00
ad0794a0bd
Add a rustfmt config and run rustfmt on the code base
2016-03-17 22:31:28 +01:00
bc41efe414
Move `.gitignore` directly under the root folder
2016-03-07 08:52:19 +00:00
5316089e61
Modify wording of confirmation request before creation of .gitignore
2016-03-02 19:38:39 +01:00
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
1eb59428e6
Ask user to create `.gitignore` and skip on `--force`
2016-02-28 15:28:11 +00:00
330b1ad55d
Add description config option
2016-02-25 14:32:49 +01:00
596455f28c
Generate simple .gitignore on init
2016-02-23 14:03:45 +00:00
88fabd76f0
Copy favicon on 'init --theme'
2016-02-22 17:20:54 +01:00
f508db6113
Add favicon support to theme
2016-02-22 17:17:07 +01:00
1083d1822d
Add default favicon.png
2016-02-22 16:59:53 +01:00
f2b913c9dd
add rounding for first and last items in theme selector
2016-02-16 11:15:08 +03:00
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
7364d41f0c
Style tables, different header bg, alternate row color and border
2016-02-05 18:09:35 +01:00
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
3fd1d4606c
Fix tests after removing PathExt from utils
2016-01-03 14:08:17 +01:00
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
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
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
5170e6b675
Fix #89 , bug introduced earlier where all headers are black in all color themes
2016-01-01 11:02:24 +01:00
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
2a7463c45b
#29 Add a way to escape {{#playpen ... } using a backslash in front: \{{#playpen ... }}
2016-01-01 01:40:37 +01:00
db7424e947
Continue #29 , playpens are now runnable
2016-01-01 00:32:12 +01:00
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
38b2dee17e
Continue #29 Check that the rust file exists and read to string
2015-12-31 14:14:56 +01:00
0cb234de5d
Add tests for find_playpens
2015-12-31 12:02:25 +01:00
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
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
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
41462e8b2d
Merge pull request #87 from funkill/keys_navigation
...
add navigation by arrows
2015-12-30 16:37:09 +01:00
43eef7637a
add navigation by arrows
2015-12-30 18:30:08 +03:00
dc8f6cd5e9
Add contributors to the doc + set visisted links to the same color as normal links
2015-12-30 15:59:18 +01:00
5b9d8ee6ac
Fix #83 , spacing is reduced between two consecutive headings
2015-12-30 15:41:49 +01:00
2d00f40a24
Tweak css for inline code blocks in sidebar
2015-12-30 00:50:22 +01:00
e40b293336
Fix #70 render inline code blocks in the sidebar
2015-12-30 00:46:55 +01:00
b40688c880
Merge branch 'master' into watch-command
2015-12-29 13:40:13 +01:00
71213f40da
Add expand/collapse button to show and hide the hidden code lines
2015-12-29 13:08:25 +01:00
0620ef1f47
Hides rust code lines prepended with #
2015-12-29 12:26:32 +01:00
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
159b300067
Merge branch 'master' into hide-rust-js
2015-12-28 16:40:56 +01:00
0dd6a17187
Fix some small things in javascript
2015-12-28 16:39:14 +01:00
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
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
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
5b289c1303
Fix 0ffd638 with smarter way to join with linebreaks.
2015-12-27 14:24:42 -07:00
0ffd638904
Add newlines back in to generated index.html files.
2015-12-27 14:10:13 -07:00
1de00f9cd7
On page load, scroll sidebar to active section.
2015-12-26 20:45:50 -07:00
b1265862c7
Generalize inline code to all themes
2015-12-22 16:30:05 -05:00
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
6bcc592ed9
Implement 'mdbook test'
...
Fixes #69
2015-12-15 13:56:24 -05:00
4ca6693a48
Update handlebars from 0.11.x to 0.12.x
2015-12-15 18:58:34 +01:00
22b6448381
Merge branch 'master' into watch-command
2015-11-10 16:33:25 +01:00
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
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
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
c1c1074292
Fix back-button cache problem? #59
2015-09-24 22:33:05 +02:00
9a43f9ff8c
Fix typo in the css classes
2015-09-24 20:56:16 +02:00
6c240090ae
Fix #47 sidebar stays hidden even after page change
2015-09-24 16:47:33 +02:00
7446743cd6
Merge branch 'css-to-stylus'
2015-09-24 15:54:48 +02:00
a177a9e10d
Only regenerate css when feature regenerate-css is enabled
2015-09-24 15:37:20 +02:00
efc0f40466
Fix low contrast in mobile nav buttons #57
2015-09-24 00:19:43 +02:00
bd99a4382f
Converted all css to stylus
2015-09-18 22:13:55 +02:00
5dfe477cd1
Should fix #56
2015-09-18 16:18:37 +02:00
c725df3edd
Add test and closes #55
2015-09-18 16:12:43 +02:00
0a50d6b33f
Fixed the error in copy_files_except_ext #55
2015-09-18 15:28:58 +02:00
e377f4702f
Preliminary setup for switching from pure css to stylus
2015-09-18 14:46:55 +02:00
103048c0d1
Merge branch 'master' of https://github.com/azerupi/mdBook
2015-09-17 19:45:36 +02:00
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
b164e0709b
Fix many minor warnings found by clippy
2015-09-16 22:48:01 -04:00
5960050676
Added my first test!! :) For copy_files_except_ext function
2015-09-16 23:39:00 +02:00
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
f3cf63c4ec
(Re)add greyed sidebar elements for links that do not exist for all themes
2015-09-14 19:20:51 +02:00
5f125bd30e
Improve the color of the spacer for the rust, coal and navy theme
2015-09-14 18:29:03 +02:00
54a56a6354
Fix flash when selecting another theme and reloading the page
2015-09-14 18:12:45 +02:00
195bfd2f7f
Merge pull request #48 from mdinger/dark_theme
...
Multiple themes
2015-09-14 17:49:29 +02:00
5a3155aba7
Fix #50 base url sometimes not correct for index.html
2015-09-14 17:45:30 +02:00
3dc8ff5e62
Add a rust theme
2015-09-14 05:25:42 -04:00
937cd36b96
Nit: remove duplicate color
2015-09-14 05:10:14 -04:00
734344671f
Add navy theme
2015-09-14 05:10:08 -04:00
e8f0428b3d
Add coal theme
2015-09-14 05:10:01 -04:00
a52f5689a6
Add javascript for switching between 3 different themes
2015-09-14 05:09:46 -04:00
b7d9cc3d0a
Consolidate light theme. Only selected menu item should
...
be highlighted. Mobile chapter switcher should highlight
when selected
2015-09-14 05:09:30 -04:00
be33f6afad
Move light theme into light class
2015-09-14 05:09:14 -04:00
872f9ea5e6
Add tomorrow night as dark code highlighting theme
2015-09-14 05:08:48 -04:00
c113c2eb31
Simplify match nesting in theme with if let
2015-09-14 05:03:08 -04:00
37b68c41f7
Theme toggle button
2015-09-14 05:02:41 -04:00
13e5e862ce
Local fallback for Font Awesome #46
2015-09-13 20:03:34 +02:00
95dfff008c
Local fallback for jquery #46
2015-09-13 19:16:11 +02:00
754773f857
Fix doc test II
2015-09-11 21:21:26 +02:00
a32d170667
fix code in doc
2015-09-11 21:01:34 +02:00
a050d9c4ad
Big refactoring, now using enum for different book items (Chapter, Affix, Spacer, ...) Closes #9
2015-09-11 20:52:55 +02:00
6962731474
Added MathJax support does not work 100% but it's better than nothing #49
2015-09-10 23:30:29 +02:00
82a774c90e
prevent page break in code blocks + force wrap in pre tags (because you can't scroll...)
2015-09-05 17:39:00 +02:00
d03ae79765
Added a page containing the whole book for printing purposes, closes #41 + cleaning root path
2015-09-05 17:26:32 +02:00
4789073e6d
Added print button + avoid pagebreaks after titles (doesn't work on chrome, should be tested in Firefox)
2015-09-05 11:40:40 +02:00
7527975b41
Added basic print support in the stylesheet. Forced background color for code blocks in chrome, has to be tested in firefox and others. #41
2015-09-05 00:06:14 +02:00
8e9dc3643f
Prevent navigation arrows from collapsing with text on smaller screen. Fix #42
2015-08-31 17:09:18 +02:00
5990c80a00
Cursor is now a pointer on menu-bar i elements. Fix #44
2015-08-31 16:15:17 +02:00
be7c0bd059
Clean up of the Renderer trait, render now borrows the book instead of the config and the book items...
2015-08-31 15:24:42 +02:00
99942cd46d
Merge pull request #45 from FuGangqiang/fgq
...
fix #8 : Init -> create files in summary.md
2015-08-30 08:43:24 +02:00
77b9882825
fix #8 : Init -> create files in summary.md
2015-08-30 00:51:23 +08:00
262aa91948
Added a utility method to remove all content of a dir but not the dir itelf. Fixes #32
2015-08-16 13:20:10 +02:00
a5aa357f57
Clean-up: Remove all 'hacky' exist checks and replace by 'exists()'
2015-08-13 10:46:56 +02:00
abae21527a
Copied the PathExt trait from the rust source code as temporary fix. Now I can replace the hacky code I used. When it goes to rust stable I will just have to remove and eventually change some
2015-08-13 10:00:44 +02:00
10d756eff0
Fix #40 where next helper returned a link to the current chapter instead of the next
2015-08-12 19:22:53 +02:00
0932bfd576
Big clean-up, reduced the unwrap's to 2 in the library part! Closes #36 The unwraps where replaced with more diverse error messages #14
2015-08-11 22:55:51 +02:00
5b487a03fc
Added user prompting and a --force argument. Closes #35
2015-08-11 16:56:09 +02:00
835c61c7f3
Some clean-up + initial implementation of '--theme' flag for init. Still needs some work
2015-08-11 16:13:41 +02:00
bf114d7e21
Removed the sub module from utils and put the functions directly in the utils module + docs #30
2015-08-06 23:04:19 +02:00
b7214f92a1
Add documentation for MDBook #30
2015-08-06 21:10:59 +02:00
c6b6069ed3
Tweaks to the docs + clean-up
2015-08-06 15:24:34 +02:00
20bfcd128d
Fixed the code examples and added no_run to prevent them from running
2015-08-06 15:04:27 +02:00
731149d37a
Fix bug where src and output where not in function of MDBook.root but the current working dir when using set_src() and set_dest()
2015-08-06 14:27:07 +02:00
a0040733e9
Fixed rust example in doc + some tweaks for html validation
2015-08-06 14:09:55 +02:00
05ab31d882
Fix #34
2015-08-06 13:58:27 +02:00
726018307e
ignored test, have to fix some bugs before
2015-08-06 12:52:06 +02:00
e725215103
Add rustdoc generated API doc
2015-08-06 12:38:48 +02:00
01369ea42f
Checked the API, moved handlebars theme handling to the theme module to expose it to every renderer. Closes #28
2015-08-05 22:35:26 +02:00
991ccb5495
Added some chapters for the documentation #30 + tweaked the syntax highlighting theme
2015-08-05 20:36:21 +02:00
58d18d467c
Fixed a bug where custom theme was appended to default theme + Changed syntax highlighting theme to something lighter, the dark theme did not fit the light style of the page
2015-08-05 19:14:03 +02:00
90719f721b
Added syntax highlighting with highlight.js Closes #31 + Added a new chapter to the docs #30 .
2015-08-05 18:28:59 +02:00
191f594e78
Added function to MDBook to swap renderer #10
2015-08-04 20:51:16 +02:00
2c22d11bfd
It's now possible to use a custom theme. Add a theme directory in your src and selectively overwrite the files you want to customize. Closes #6
2015-08-04 17:58:09 +02:00
4ead44457a
Added a new macro 'output' that can be disabled by a feature
2015-08-04 17:13:24 +02:00
1095e7c773
Clean-up handlebars renderer, move some parts to utils module
2015-08-04 16:52:10 +02:00
bca6a7aa13
[Clean-up] Reorganize structure in handlebars renderer
2015-08-04 15:15:36 +02:00
16318273f3
Merge the updated handlebars helpers in master. Closes #26
2015-08-04 12:58:20 +02:00
842196b91c
Cleaned up the handlebars helpers, it's a lot more customizable because the user can put whatever template he wants inside and I just expose link and name of previous / next chapter. JavaScript part is removed. #26
2015-08-04 12:52:32 +02:00
4ae77d771a
Moved book.json from src to root. Now src can be set to whatever you want. Closes #27
2015-08-04 01:25:41 +02:00
a77fe94c02
Started to clean the 'previous' and 'next' handlebars helpers #26 But got stuck, waiting for a response
2015-08-03 22:09:26 +02:00
91b0a99d81
Fix bug in menu-bar title, again... Because I didn't solve it previously
2015-08-03 18:17:39 +02:00
22280bbb16
Add debug! macro that can be activated using the "debug" feature. #19
2015-08-03 18:06:01 +02:00
fd58a4d441
Fix bug where menu-bar title was on top of the menu-bar icons making them unclickable
2015-08-03 14:59:18 +02:00
c64824a18c
Added author and dest field in book.json, fixed bug when output directory did not exist. Closes #7
2015-08-03 14:23:32 +02:00
9b4298c066
Initial implementation for reading the config file: book.json #7
2015-08-03 01:37:13 +02:00
ef00851b8e
Fixes #24
2015-08-01 17:21:05 +02:00
5b11907a56
Added navigation icons + javascript code to hide them when there is no previous or next. Closes #12
2015-08-01 14:18:25 +02:00
c7361704b9
uses clap to simplify CLI
2015-08-01 00:59:05 -04:00
c64f3ac973
Added handlebars helpers for navigation, need to find a place where to put them on the page #12
2015-07-31 18:34:43 +02:00
31f638eae3
Add active class to currently viewed chapter in the sidebar. Closes #20
2015-07-31 15:06:08 +02:00
1a8c2259e5
Split the handlebars renderer in his own module because it was becoming large
2015-07-30 15:38:21 +02:00
5bd1385212
Added a utils module for general / common functions
2015-07-30 15:20:55 +02:00
c63ca25e43
Clean up: Removed uneeded function because the same functionality is present in std
2015-07-30 13:49:49 +02:00
1111ff3ceb
Fixes 2 bugs with relative paths. Fixed by injecting a variable path_to_root into the json data for the handlebars template. Fixes #17
2015-07-29 23:32:01 +02:00
6a4b8d51b4
create a copy of the first rendered page and use that as index.html... Closes #16
2015-07-29 22:26:13 +02:00
94d3d65a0e
Change link color + add transition animation on menu-bar icons on hover. Closes #15
2015-07-29 21:53:59 +02:00
0e27a473c5
Sidebar is now hidden on mobile devices and can be hidden/shown with the button
2015-07-29 13:34:48 +02:00
ecdcc31e9e
Added function to clean links before inserting in toc
2015-07-29 12:10:12 +02:00
a55a676bbe
support empty links in rendered html
2015-07-29 01:40:48 +02:00
9a9fadac77
Forgot to update level variable, fixed now.
2015-07-29 01:06:46 +02:00
f500b4a836
Rough implementation for handlebars helper to display toc correctly, probably needs a little bit of cleaning... Url in toc doesn't work yet. It needs to be cleaned before './url' -> '/url' and 'url' -> '/url'
2015-07-29 00:57:47 +02:00
4203b5b1c4
added markdown with 'pulldown-cmark', added basic styling, render of the toc is still not completely done
2015-07-28 21:01:13 +02:00
be0bfa7170
Split of the creating of the JSon object into it's own function
2015-07-19 14:02:21 +02:00
4d4f35ecba
First big step for the html renderer, it reads an handlebars template and creates the files from SUMMARY.md respecting the source folder structure
2015-07-19 00:08:38 +02:00
35be20da8b
Fixed bug where spaces where not trimmed and only the first level was parsed correctly
2015-07-18 16:21:04 +02:00
60e47d2e08
fix error in init(): write "- [chapter 1](...)" to SUMMARY.md instead of "[chapter 1](...)" note the lack of dash at the beginning
2015-07-18 00:14:04 +02:00
7fa5b06ccb
Rudimentary: Parse SUMMARY.md, support for nested levels. Only list items: "- [name](path)" or "* [name](path)" #2
2015-07-18 00:04:20 +02:00
4fe0bc2de5
renamed directory + created BookItem
2015-07-16 19:26:16 +02:00
ad01c37432
clean up structure and code
2015-07-16 18:20:36 +02:00
4d884b9c40
Added BookConfig struct, cleaned up some parts
2015-07-08 15:17:11 +02:00
39c0344f9a
Added README.md
2015-07-08 00:04:28 +02:00
508f3068f0
Added arg for init to specify directory
2015-07-07 12:36:11 +02:00
a6b3f99c53
Init now creates 'src' and 'book' folder. In 'src' SUMMARY.md is created with one dummy chapter
2015-07-07 11:51:06 +02:00
a27bc498eb
Started to implement init
2015-07-07 02:56:19 +02:00
b94304405a
Skeleton for main.rs (binary)
2015-07-06 21:12:24 +02:00
d5a8d7f3a1
Initial commit
2015-07-06 14:21:59 +02:00
Matt Ickstadt
cetra3
Lucas Morales
eyenseo
Hiroki Noda
Andrew Gauger
Mathieu David
Tim Ryan
Weihang Lo
Matt Brubeck
Michael Bryan
Gwen Lofman
Nils
Bastien Orivel
Anders Rasmussen
Guillaume Gomez
Dylan Maccora
Pawel Duzinkiewicz
Sorin Davidoi
Bulat Musin
boxdot
Steve Klabnik
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
Federico Fissore
messense
Jimmy Do
Ning Sun
pravic
Cldfire
superstring
aaaxx
Phil Ruffwind
Corey Farwell
CrazyMerlyn
Vincent Esche
Jesse Millikan
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
Lucio Franco
vrinek
Jesse Stricker
funkill
Istratov D. S
asolove
mdinger
Mathieu David
FuGangqiang
Kevin K
