Render About and API pages from Markdown docs - #61
Merged
Merged
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
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.
The About and Algorithm API pages previously embedded their content in TSX. Render them from
docs/about.mdanddocs/api.mdthrough a shared Markdown component, so content can be edited directly and additional documents can be published with small static routes.The renderer supports tables, code blocks, and links between published documents under the site's base path. Both pages match the header width; the API retains bold methods and adds labeled marker-color swatches. About tells the 2013 origins and 2026 AI modernization story, while the API explains recording and item references with a runnable insertion-sort example. The header now links to GitHub through an accessible black Octocat icon.
Development documentation explains how to publish more pages without exposing every file in
docs/.Validation:
pnpm run check: lint, formatting, spelling, types, 362 unit tests, and static production build passed.