Commit Graph

166 Commits

Author SHA1 Message Date
Adam Avramov b1f7a4667d docs(mdbookignore): add manual line breaks 2024-03-07 13:31:12 +01:00
Bergmann89 fcf98be339 Add documentation and unit tests for `.mdbookignore` 2024-03-07 13:31:12 +01:00
Eric Huss d28cf53009 Rename curly-quotes to smart-punctuation. 2024-02-25 13:42:44 -08:00
Wil Wade 58a23e06a1
Fix incorrect theme documentation
The theme documentation for next and previous used name instead of title
2024-02-20 15:29:30 -05:00
Eric Huss c5a506e240 Update to 0.4.37 2024-02-06 19:34:15 -08:00
Eric Huss 93bd457a54 Update env_logger to 0.11 2024-02-05 14:22:21 -08:00
Jvst Me ba14f4ad53
docs: Fix broken link 2024-02-04 16:47:52 +03:00
gibbz00 45a2d0b40e Fix minor sentencing issue in build.md 2024-02-04 08:57:50 +01:00
Joe Taber 63000bc122
summary.md: clarify that part titles must be h1 headers 2024-01-31 01:47:05 -06:00
GeckoEidechse 7ce3a41184
docs: Add missing `+` in diff code block
The closing bracket for the `if` statement is also nearly added but the leading `+` to indicate that was forgotten.
2024-01-30 17:43:37 +01:00
Max Heller 721274239a
fix typo in guide 2024-01-03 19:46:10 -05:00
Eric Huss aa8982bdb4 Update to 0.4.36 2023-11-29 14:50:26 -08:00
Eric Huss 847a582022 Update msrv to 1.70 2023-11-29 14:36:39 -08:00
Joseph Perez 982608246e
fix typo 2023-11-19 14:46:50 +01: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
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
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
Eric Huss 4749f9d97a Some minor corrections from code review. 2023-09-02 16:41:59 -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
Tshepang Mbambo 0b0b548d7a
docs: future expansion to non-Rust testing already implied 2023-09-01 05:11:18 +02:00
Eric Huss 55c017cad1 Update to 0.4.34 2023-08-05 14:34:42 -07:00
Eric Huss 891b7c06f2 Update to 0.4.33 2023-08-03 17:03:40 -07:00
Tshepang Mbambo e57fce290b
misplaced bracket 2023-07-21 15:29:56 +02:00
Eric Huss 75f5862218 Fix link on case-sensitive filesystems. 2023-07-19 07:54:39 -07:00
Eric Huss 38fcfd8732 Update to 0.4.32 2023-07-16 17:35:51 -07:00
Eric Huss 28ce772ae9 Update msrv to 1.66. 2023-07-16 13:21:45 -07:00
Antoine 6d265c1cce
Add oh-my-zsh quick exemple to shell completions
I have trouble to find this information, doesn't cost must to add it here.
2023-07-08 13:48:51 +02:00
Eric Huss 904aa530b5
Merge pull request #2111 from ehuss/bump-version
Update to 0.4.31
2023-06-29 13:10:11 -07:00
Eric Huss fa316f3edc Update to 0.4.31 2023-06-29 12:33:55 -07:00
Eric Huss 4f15a3f85c Document that strikethrough can also use a single tilde. 2023-06-29 12:27:06 -07:00
Eric Huss a38b854338 Fix some spellings 2023-06-25 11:37:53 -07:00
Caleb Robson 056e45a003
Fix typo 2023-06-24 15:35:40 +01:00
Tshepang Mbambo 3c7795cf44
main branch is not always "master" these days 2023-06-07 18:47:15 +02:00
Eric Huss d2bcd04133 Update to 0.4.30 2023-05-28 14:54:05 -07:00
Eric Huss 5572d3d4de Expand on hidelines documentation. 2023-05-28 14:04:58 -07:00
Eric Huss 1441fe0b91 Explicitly document the `hidelines` key. 2023-05-28 14:04:58 -07:00
Jannik Obermann 7df1d8c838 Support hidden lines in languages other than Rust
Co-Authored-By: thecodewarrior <5467669+thecodewarrior@users.noreply.github.com>
2023-05-28 14:04:54 -07:00
Eric Huss b141297651 Update documentation for heading attributes 2023-05-28 11:31:35 -07:00
Uriel 0cb977e603 docs suggestion
Co-authored-by: Eric Huss <eric@huss.org>
2023-05-28 10:47:14 -07:00
ImUrX a4e206168d Add working heading extension 2023-05-28 10:47:13 -07:00
Eric Huss db6699dae2 Update to 0.4.29 2023-05-13 12:26:29 -07:00
Eric Huss be966cfe1f Raise MSRV to 1.65 2023-05-13 09:41:10 -07:00
liutailin aac6de01de
Update renderers.md
Missing symbol ":"
2023-05-13 00:04:12 +08:00
Eric Huss af036d9f45
Merge pull request #2057 from seanpoulter/init-skip
fix(cli): init --force skips confirmation prompts
2023-04-30 14:18:30 -07:00
Dylan DPC 41567b0456
Merge pull request #2076 from ehuss/gitignore
Switch from gitignore to ignore
2023-04-23 11:12:26 +05:30
Eric Huss 35fdd00203 Switch from gitignore to ignore 2023-04-22 12:53:54 -07:00
expikr 7a435be018
Update init.md 2023-04-18 01:53:38 +08:00
Sean Poulter 0003072623 docs(cli): Add docs for --force 2023-04-03 08:36:47 -04:00