fix(docs): improve mkdocs admonition compatibility and robustness #38
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- normalize admonition types to lowercase (e.g., `!!! Note` -> `::: note`) to match VitePress custom container expectations. - automatically strip dangling code fences from admonition content to prevent rendering errors caused by malformed markdown (e.g., in `docs/coil/compose.md`). Solution: - Replaced the fixed `height` on `.card` with `min-height` to allow cards to grow dynamically with their content. - Added a `line-height` to `.cardTitle` to ensure multi-line titles are legible. - Introduced media queries (`@media`) to: - Decrease `padding` within `.cardContent` on smaller screens. - Scale down `font-size` for titles and descriptions on mobile viewports for a more balanced layout.
- Relax regex to `\S+` to support non-ASCII admonition types (e.g., `!!! 注意`). - Add specific mapping for `!!! 注意` to render as `::: note 注意`. - Normalize standard admonition types to lowercase (e.g., `!!! Note` -> `::: note`). - Automatically strip dangling code fences from admonition content to fix rendering issues in files like `docs/coil/compose.md`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
!!! Note->::: note) to match VitePress custom container expectations.docs/coil/compose.md).fix(docs): enhance mkdocs admonition support for unicode and stability
\S+to support non-ASCII admonition types (e.g.,!!! 注意).!!! 注意to render as::: note 注意.!!! Note->::: note).docs/coil/compose.md.