actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,261 Commits 9 Branches 89 Tags 16 MiB
Commit Graph

2261 Commits

Author SHA1 Message Date
Stephen Checkoway 32687e64fe Color test output and shorten chapter paths 
Currently, the output from `rustdoc --test` is not colored because
`rustdoc`'s stdout is not a tty. The output of a failed `rustdoc` run is
sent to `mdbook`'s stderr via the `error!()` macro. This commit checks
if stderr is a tty using the standard `.is_terminal()` and if so, passes
`--color always` to `rustdoc`.

The test output from `rustdoc` includes the full path that `rustdoc` was
called with. This obscures the path of the file with the error. E.g.,
```
---- /var/folders/9v/90bm7kb10fx3_bprxltb3t1r0000gn/T/mdbook-tnGJxp/lab0/index.md - Lab_0__Getting_Started (line 3) stdout ----
error: expected one of `!`, `.`, `::`, `;`, `?`, `{`, `}`, or an operator, found `code`
 --> /var/folders/9v/90bm7kb10fx3_bprxltb3t1r0000gn/T/mdbook-tnGJxp/lab0/index.md:4:6
  |
3 | this code has a bug
  |      ^^^^ expected one of 8 possible tokens

error: aborting due to previous error
```

This commit runs `rustdoc` in the temp directory and replaces any
relative library paths with absolute library paths. This leads to
simpler error messages. The one above becomes
```
---- lab0/index.md - Lab_0__Getting_Started (line 3) stdout ----
error: expected one of `!`, `.`, `::`, `;`, `?`, `{`, `}`, or an operator, found `code`
 --> lab0/index.md:4:6
  |
3 | this code has a bug
  |      ^^^^ expected one of 8 possible tokens

error: aborting due to previous error
```
(with colors, of course).
 2023-12-06 12:09:07 -05:00
Eric Huss b7f46213c7
Merge pull request #2253 from ehuss/bump-version 
Update to 0.4.36
 2023-11-29 22:54:44 +00:00
Eric Huss aa8982bdb4 Update to 0.4.36 2023-11-29 14:50:26 -08:00
Eric Huss 14826db606
Merge pull request #2252 from ehuss/update-lockfile 
Update dependencies
 2023-11-29 22:44:41 +00:00
Eric Huss 847a582022 Update msrv to 1.70 2023-11-29 14:36:39 -08:00
Eric Huss 97cd00faeb Update dependencies 2023-11-29 14:29:31 -08:00
Eric Huss 8d4193fb46
Merge pull request #2229 from leonzchang/fix/normalize-path 
Fix `mdbook serve` unexpected panic
 2023-11-29 22:16:39 +00:00
leonzchang 8d4ae388fa
update comment 2023-11-29 11:51:23 +08:00
leonzchang 7082689866
add comment 2023-11-29 11:50:07 +08:00
leonzchang 40c034ed3f
apply suggest changes 2023-11-29 11:34:08 +08:00
Dylan DPC 208d5ea7ab
Merge pull request #2250 from DuckDuckWhale/master 
Dep: fix Tungstenite DoS (RUSTSEC-2023-0065)
 2023-11-26 09:42:25 +00:00
DuckDuckWhale ed51438c8b
Dep: fix Tungstenite DoS (RUSTSEC-2023-0065) 2023-11-26 01:05:20 -08:00
Eric Huss 49fce6673a
Merge pull request #2209 from cyevgeniy/feat/sidebar-resize-indicator 
Add resize indicator to the sidebar
 2023-11-24 20:31:14 +00:00
Eric Huss a016ac0d2b
Merge pull request #2173 from 0xpr03/master 
upgrade to notify 6.1.1 and watcher-mini 4.1
 2023-11-24 20:05:37 +00:00
Eric Huss ad55f5367e
Merge pull request #2162 from ISSOtm/padding-hljs 
Fix code blocks "indent" without highlight.js
 2023-11-24 19:59:55 +00:00
Eric Huss 660cbfa6ce
Merge pull request #2243 from wyfo/patch-1 
fix typo
 2023-11-19 13:53:15 +00:00
Joseph Perez 982608246e
fix typo 2023-11-19 14:46:50 +01:00
Dylan DPC 6f6de2cf05
Merge pull request #2235 from ardcore/improvement/fix-print-margin 
Make sure page wrapper transform is removed in print mode
 2023-11-16 13:44:27 +00:00
Szymon Pilkowski ae3e3f8269 Make sure page wrapper transform is removed in print mode 2023-11-10 21:51:00 +01:00
Eric Huss dc21f1497b
Merge pull request #2232 from arnetheduck/add-nim 
Add Nim to default languages
 2023-11-09 03:32:44 +00:00
Jacek Sieka 5c8941ba16 Add Nim to default languages 
Nim is a systems programming language (included in the highlight.js
`system` group), and we're quite happily using `mdBook` in several of
our documentation projects starting with our [style
guide](https://status-im.github.io/nim-style-guide/).

While we can maintain our own highlight.js, including `Nim` in the
default distribution would allow us to promote more mdBook usage in the
Nim community at the cost of a ~2kb increase in the `highlight.js` size.
 2023-11-08 15:34:35 +01:00
leonzchang b0a001c6a4
create relative path through ignore root and path 2023-11-08 13:35:35 +08:00
leonzchang 722c55f85f
normalize path to relative 2023-11-01 12:33:13 +08:00
leonzchang 3ab19f3295
Revert "bump version v0.4.36" 
This reverts commit 621ffc46c0.
 2023-10-31 12:22:08 +08:00
leonzchang 621ffc46c0
bump version v0.4.36 2023-10-31 12:14:28 +08:00
leonzchang fbb629c02e
normalize path in watch cmd 2023-10-31 12:13:25 +08:00
Evgeny Chaban 80d3a86468 fix: hide resize indicator on devices with limited accuracy 2023-10-04 01:55:20 +03:00
Evgeny Chaban 8e8fd2717e fix(style): use calc function 2023-10-04 01:40:16 +03:00
Evgeny Chaban f92d24e89c feat(sidebar): add sidebar indicator 2023-10-02 18:24:55 +03:00
Eric Huss 94e0a44e15
Merge pull request #2206 from ehuss/bump-version 
Update to 0.4.35
 2023-09-29 22:43:05 +00:00
Eric Huss f25181f68d Update to 0.4.35 2023-09-29 14:33:45 -07:00
Eric Huss cf19eb1386 Fix `text-direction` in documentation. 2023-09-29 14:33:20 -07:00
Eric Huss 0583119698
Merge pull request #2197 from dluschan/patch-1 
Update index.hbs
 2023-09-22 17:26:27 +00:00
Dmitry Luschan 3389f3db7f
Update index.hbs 
Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.
 2023-09-19 20:44:39 +06:00
Eric Huss c642f5f8a3
Merge pull request #2187 from notriddle/notriddle/warning-block 
Add `.warning` class for doc author use
 2023-09-09 20:13:10 +00:00
Michael Howell ceb8b509e2 Add more guides to stock CSS classes 2023-09-08 13:27:02 -07:00
Michael Howell 65dae11e47 Add `.warning` class for doc author use 
This is designed to be compatible with rustdoc's version, in
https://github.com/rust-lang/rust/pull/106561
 2023-09-08 13:17:21 -07:00
Dylan DPC d5b1676216
Merge pull request #2168 from pickfire/prefetch 
Add prefetch to next link
 2023-09-04 18:03:38 +00:00
Eric Huss 09f222baf7
Merge pull request #1641 from cN3rd/rtl 
Continued work on "Support right-to-left languages"
 2023-09-02 23:57:48 +00:00
Eric Huss 802e7bffc3 Make the arrow keys honor RTL. 
At least to my understanding, the pages will flip in the opposite direction.
 2023-09-02 16:44:47 -07:00
Eric Huss fb272d1afa Fix theme selector for RTL. 2023-09-02 16:43:21 -07:00
Eric Huss b871676def Fix sidebar behavior with RTL. 2023-09-02 16:43:13 -07:00
Eric Huss 869fe2f50d Remove text_drection_from_lang_code 
The test above should cover this sufficiently.
 2023-09-02 16:42:53 -07:00
Eric Huss db877b1c9b Update language list to include missing rtl languages. 2023-09-02 16:42:14 -07:00
Eric Huss 4749f9d97a Some minor corrections from code review. 2023-09-02 16:41:59 -07:00
cN3rd 8564a7fb51 Add proper test to inline code within the book. 2023-09-02 14:38:02 -07:00
cN3rd 6be98e0bbd Ensure code segments always render in LTR 2023-09-02 14:37:59 -07:00
cN3rd 5e0c68c45e Fix icons when using RTL 2023-09-02 07:50:23 -07:00
cN3rd 7717b9dcf2 Support `text_direction` attribute in HTML output 2023-09-02 07:50:21 -07:00
cN3rd 819a108f07 Add `text_direction` property in general book metadata 
Text direction can selected in the config via the `text_direction` attribute in `book.toml`,
or be derived from the book's language.
 2023-09-02 07:49:28 -07:00