Skip to content

Commit

Permalink
mdbook_trpl: apply auto-formatting to READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriskrycho committed Dec 5, 2024
1 parent ba41fae commit 7cd2034
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion packages/mdbook_trpl/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mdbook_trpl

A shared package for [mdbook][] [preprocessors][pre] used in [_The Rust
A shared package for [mdbook][mdbook] [preprocessors][pre] used in [_The Rust
Programming Language_][trpl].

Supplies the following preprocessor binaries:
Expand Down
4 changes: 2 additions & 2 deletions packages/mdbook_trpl/src/bin/README - mdbook-trpl-note.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mdbook-trpl-note

This is a *very* simple [preprocessor][pre] for [mdBook][mdbook], focused specifically on the content of _The Rust Programming Language_ book. This preprocessor takes Markdown like this—
This is a _very_ simple [preprocessor][pre] for [mdBook][mdbook], focused specifically on the content of _The Rust Programming Language_ book. This preprocessor takes Markdown like this—

```markdown
> Note: This is some material we want to provide more emphasis for, because it
Expand Down Expand Up @@ -37,7 +37,7 @@ Here is all the important things to know about that particular subject.
This allows using the relatively standard Markdown convention of (incorrectly!) using blockquotes for “callouts” or “notes” like this, while still producing semantic HTML which conveys the actual intent.

> [!NOTE]
> This is *not* a full “admonition” preprocessor, and it is not remotely compliant with [the GitHub “alert” syntax][alerts]. It exists almost entirely for the sake of providing better semantic HTML for _The Rust Programming Language_ book with a minimum of disruption to existing workflows!
> This is _not_ a full “admonition” preprocessor, and it is not remotely compliant with [the GitHub “alert” syntax][alerts]. It exists almost entirely for the sake of providing better semantic HTML for _The Rust Programming Language_ book with a minimum of disruption to existing workflows!
>
> You are probably better off using one of the other existing alert/admonition preprocessors:
>
Expand Down

0 comments on commit 7cd2034

Please sign in to comment.