Fix unstyled tip admonition on the customize layouts page - #6329
Fix unstyled tip admonition on the customize layouts page#6329pasindubalasooriya wants to merge 1 commit into
Conversation
The tip in step 5 of "Add custom layouts" had its content at the same indentation as the !!! tip marker. Python-Markdown requires the content to be indented four spaces past the marker, so the admonition rendered as an empty tip box and the sentence fell out as a plain paragraph instead of being styled like the other tips on the page. Indent the marker and its content to match the pattern used elsewhere in the file.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe pull request corrects the indentation of the restart tip in the custom layouts branding guide. The tip text remains unchanged. ChangesBranding documentation
Change: Other Merge Risk: ⚪ Minimal · up to The restart tip now renders consistently with the other styled tips, without changing its content. No current merge-readiness risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Git: CodeRabbit could not clone the repository, so clone-backed analysis was skipped and this review may be incomplete. Verify repository clone access, such as SSH credentials, before requesting another full review. If clone access is intentionally unavailable, use Comment |
1 participant
Purpose
The tip in step 5 of the
Add custom layoutssection is not styled like the other tips on the page. It renders as an empty tip box followed by an unstyled paragraph.The admonition content was written at the same indentation as its
!!! tipmarker:Python-Markdown requires the content to be indented four spaces past the marker, so the admonition was parsed with no content and the sentence became a separate plain paragraph. The marker and its content are now indented to match the pattern used by every other admonition in the file.
Live page: https://is.docs.wso2.com/en/7.1.0/guides/branding/add-custom-layouts/#step-3-add-a-custom-layout-design
File changed:
en/includes/guides/branding/add-custom-layouts.mdThis file is a shared include, so the fix applies to IS 7.0.0, 7.1.0, 7.2.0, 7.3.0 and next. Each of those versions holds only a one line stub that includes this file, so there is no per version copy to update.
I also checked every other admonition in the file and confirmed the tip in step 5 was the only one affected.
Related PRs
None
Test environment
Built IS 7.1.0 locally with its own
mkdocs.ymland pinnedrequirements.txton Python 3.12, then served the output and inspected the rendered HTML.Security checks