From 3e6484f8a7f6dffaa331ffa5a8610fb83e7dff25 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Tue, 14 Jul 2026 00:06:22 +0300 Subject: [PATCH] fix(docs): enable admonition extension; fix DI steer line breaks 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
, 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
tricks. Verified: profile renders 4 tables, 0
, 2

; the site renders a real

with title + 2 paragraphs and no literal '!!!'. --- docs/index.md | 1 + mkdocs.yml | 1 + profile/README.md | 9 +++------ 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 327f25e..4294dbb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -103,6 +103,7 @@ catalog below. the resolve path itself stays synchronous, and resources that need to `await` are constructed in the framework lifespan ([recipe](https://modern-di.modern-python.org/recipes/async-lifespan/)). + [`that-depends`](https://github.com/modern-python/that-depends) is the async-first sibling and stays maintained; it ships a migration guide to `modern-di`. diff --git a/mkdocs.yml b/mkdocs.yml index 5ffe36f..dfb58d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,7 @@ extra_css: - stylesheets/extra.css markdown_extensions: + - admonition - attr_list - md_in_html - pymdownx.emoji: diff --git a/profile/README.md b/profile/README.md index 800443f..e325267 100644 --- a/profile/README.md +++ b/profile/README.md @@ -21,12 +21,9 @@ Open-source templates and libraries for building production-ready Python applica ### Dependency injection -**Which one?** Start new projects on [`modern-di`](https://github.com/modern-python/modern-di) -— a minimal core plus the integrations below. Async apps are first-class: the -resolve path itself stays synchronous, and resources that need to `await` are built -in the framework lifespan. [`that-depends`](https://github.com/modern-python/that-depends) -is the async-first sibling and stays maintained; it ships a migration guide to -`modern-di`. +**Which one?** Start new projects on [`modern-di`](https://github.com/modern-python/modern-di) — a minimal core plus the integrations below. Async apps are first-class: the resolve path itself stays synchronous, and resources that need to `await` are built in the framework lifespan. + +[`that-depends`](https://github.com/modern-python/that-depends) is the async-first sibling and stays maintained; it ships a migration guide to `modern-di`. | Project | What it is | Stars | Downloads | |---|---|---|---|