Commit f2e4f08
authored
fix(docs): enable admonition extension; fix DI steer line breaks (#49)
Two rendering bugs in the DI steer shipped in #48.
1. modern-python.org was serving the literal text '!!! tip "Which one should
I use?"' with the body as a raw code block. The admonition extension was
never enabled in mkdocs.yml -- the site had no other admonition, so nothing
had caught it. mkdocs build --strict passes either way, since a fell-through
block is valid markdown, just not the markdown you meant.
2. On the org profile, GitHub renders a single newline as <br>, so the
hard-wrapped paragraph broke mid-sentence in 8 places. The rest of
profile/README.md avoids this by leaving prose unwrapped.
Both surfaces now carry the steer as two blank-line-separated paragraphs, which
renders identically under GFM and Python-Markdown with no <br> tricks.
Verified: profile renders 4 tables, 0 <br>, 2 <p>; the site renders a real
<div class="admonition tip"> with title + 2 paragraphs and no literal '!!!'.1 parent 2e9d42e commit f2e4f08
3 files changed
Lines changed: 5 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
| 106 | + | |
106 | 107 | | |
107 | 108 | | |
108 | 109 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| 38 | + | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
30 | 27 | | |
31 | 28 | | |
32 | 29 | | |
| |||
0 commit comments