Ensure consistent markdown formatting in documentation by wrapping all technical terms, API names, property names, and code-related content in backticks. This improves readability and maintains visual consistency across documentation.
Examples of proper formatting:
classNames
, styles
, href
, variant
aria-*
, shape="round"
@layer antd
Common mistakes to avoid:
classNames
instead of classNames
variant="filled"
instead of variant="filled"
This standard ensures that code-related content is visually distinguished from regular text, making documentation easier to scan and understand for developers.
Enter the URL of a public GitHub repository