feat: implement syntax highlighting with Prism.js for API documentation #20
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
- Hero section: reduce font sizes, improve spacing, fix code terminal layout - Documentation: optimize sidebar width, reduce padding for mobile - Overview section: responsive typography, better code block handling - Reproduction Rate: mobile-friendly math formulas with overflow handling - Add responsive breakpoints for xs/sm screens (360px+) - Improve touch targets and content readability on mobile devices
- Stack grid columns on mobile (grid-cols-1) - Reduce text sizes further: text-base for headings, text-[10px] for code - Smaller padding on mobile: p-2 instead of p-3 - Use break-all for long URLs to prevent horizontal overflow - Adjust icon sizes to be smaller on mobile (w-3 h-3) - Better spacing between sections with reduced margins
- Add CodeBlock component with copy-to-clipboard functionality - Install Prism.js with support for bash, JSON, JavaScript, TypeScript, Python, Go - Update all API endpoint sections with comprehensive code examples: - National Latest: cURL request and JSON response examples - National Historical: basic and paginated requests with array response - Health Check: health endpoint request and response - Root Endpoint: API overview request and response - Provinces: provinces list with latest case data structure - Province Cases: enhanced examples with ODP/PDP tracking - Error Handling: error response JSON with proper structure - Fix reproduction rate structure to use 'value' instead of 'mean' - Correct provinces response structure based on swagger.yaml specification - Add proper ODP/PDP (observation/supervision) data tracking - Ensure all examples match actual API models from Go backend - Responsive design for mobile devices with proper syntax highlighting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Changes Made
New Components
Updated Documentation Sections
API Structure Corrections
Technical Improvements
Test Plan