Ensure documentation code blocks use appropriate syntax highlighting and provide comprehensive, functional examples. For shell commands in markdown, use sh syntax highlighting rather than console for better highlighting accuracy and copy functionality. When documenting APIs or components, provide multiple complete examples that demonstrate different usage patterns rather than incomplete snippets.
Example of proper shell command formatting:
$ npm install ink@next react
Example of comprehensive API documentation:
import { Text } from "ink"
// Basic usage
<Text color="red">Error message</Text>
// Background color
<Text bgRed>Alert</Text>
// RGB colors
<Text rgb={[255, 255, 255]}>Custom color</Text>
This approach improves code readability in documentation and helps developers understand the full scope of available options through practical, working examples.
Enter the URL of a public GitHub repository