jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2436 commits 2 branches 0 tags 9.1 MiB
Commit graph

82 commits

Author SHA1 Message Date
Eric Huss
09a37284b0 Add output.html.search.chapter 
This config setting provides the ability to disable search indexing on a
per-chapter (or sub-path) basis.

This is structured to possibly add additional settings, such as perhaps
a score multiplier or other settings.
 2025-01-27 19:45:50 -08:00
Max Heller
d325e821cd
fix: make line hiding in Rust code blocks consistent with rustdoc 
Requires a space following a `#` for a line to be hidden.
 2025-01-20 11:43:39 -05:00
Eric Huss
5ed3223185 Fix broken link to "Smart Punctuation" 2024-06-24 14:32:55 -07:00
Eric Huss
89878519b4 docs: Switch the guide to use smart punctuation. 2024-05-13 13:43:04 -07:00
Dylan DPC
bf3de7a80d
Revert "Maybe a typo in preprocessors.md" 2024-05-13 20:31:18 +05:30
TheGeekInTheShell
8308f15e93
Maybe a typo in preprocessors.md 
It seems to me there is a small typo in the file preprocessors.md
 2024-05-12 14:35:21 +02:00
Eric Huss
c671c2e904
Merge pull request #2262 from Janik-Haag/master 
Add nix to default languages
 2024-04-12 15:27:31 +00:00
Janik H.
c9df8dd1f3
Add nix to default languages 2024-04-10 21:56:13 +02: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
Jvst Me
ba14f4ad53
docs: Fix broken link 2024-02-04 16:47:52 +03:00
Joe Taber
63000bc122
summary.md: clarify that part titles must be h1 headers 2024-01-31 01:47:05 -06:00
Max Heller
721274239a
fix typo in guide 2024-01-03 19:46:10 -05: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
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
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
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
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
liutailin
aac6de01de
Update renderers.md 
Missing symbol ":"
 2023-05-13 00:04:12 +08:00
Andreas Deininger
a2c88ae0f1 Convert links from http to https protocol 2023-04-02 21:35:08 +02:00
Eric Huss
c2d973997a Make fonts part of the theme. 2023-01-15 11:42:46 -08:00
Eric Huss
9764f8886b
Fix MDBOOK_BOOK environment variable example 2022-12-28 19:21:38 -08:00
Will Crichton
144a1e4009 Add documentation for extra-watch-dirs 2022-11-12 14:28:43 -08:00
Joep Meindertsma
b3941526cb
Explain how to use site-url 
Make sure people use the right kind of asset-urls. This issue only shows up when deploying, not using `mdbook serve`.
 2022-08-23 10:33:25 +02:00
Fauconfan
a8a45a5fbe authors -> author in user guide 2022-07-09 15:31:00 +02:00
Shogo Takata
2ae7f007cc
add doc in mdbook.md 2022-03-27 17:28:42 +09:00
Shogo Takata
89e37a7751
add docs 2022-03-26 16:11:41 +09:00
Daniel Morawetz
9e6217871e
add page-break option to docs 2022-01-17 18:07:22 +01:00
Eric Huss
f2fba30786 Update documentation 2021-12-19 20:26:37 -08:00
Eric Huss
f3e5fce6bf
Merge pull request #1709 from joshrotenberg/markdown-page 
Markdown page
 2021-12-19 13:26:41 -08:00
josh rotenberg
2d36cd9263 more markdown 2021-12-18 16:00:46 -08:00
josh rotenberg
09087097b5 add more sections here 2021-12-18 15:50:51 -08:00
josh rotenberg
18b9f42fba add the markdown page 2021-12-17 19:08:58 -08:00
Eric Huss
e3e170715e
Merge pull request #1706 from vaporup/patch-1 
Fix Typo in summary.md
 2021-12-16 13:53:22 -08:00
Sven Wick
4e03818f3e
Update summary.md 2021-12-16 18:29:47 +01:00
Alessandro Coglio
3f268cb0df
Fix typo. 2021-12-15 20:53:01 -08:00