docs: Docusaurus documentation site + GitHub Pages workflow - #13
Merged
Merged
Conversation
- website/: Docusaurus 3.10 site, kept outside the npm workspaces so its dependencies never mix with the React Native ones. Eight pages moved from the README: getting started, supported HTML, styling and cascade, props, custom rendering, plugins, how it works, limitations. The landing page embeds example/App.tsx in Expo Snack (SDK 56) as a live playground. - .github/workflows/docs.yml: builds the site on pull requests touching website/, builds and deploys to GitHub Pages on push to main. Pages must be enabled once with "Source: GitHub Actions" before the deploy job can succeed. - README (root + core): docs badge linking to https://nikpnevmatikos.github.io/Html-Renderer/ Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
What this adds
website/: a Docusaurus 3.10 site with eight pages moved from the README (getting started, supported HTML, styling and cascade, props, custom rendering, plugins, how it works, limitations). The landing page embedsexample/App.tsxin Expo Snack on SDK 56 as a live playground. The folder is deliberately not an npm workspace member; it has its ownpackage.jsonand lockfile..github/workflows/docs.yml: builds the site on pull requests that touchwebsite/(this PR will run it as a check), and builds + deploys to GitHub Pages on push tomain.packages/core) linking to https://nikpnevmatikos.github.io/Html-Renderer/.Verified locally
npm run buildinwebsite/succeeds withonBrokenLinksandonBrokenAnchorsset tothrow.npm run typecheckinwebsite/passes.sdkVersion=56.0.0andplatform=web, and that the docs pages render with sidebar and table of contents.Before merging: enable GitHub Pages (one time)
Repository Settings → Pages → Build and deployment → Source: GitHub Actions. Nothing else to configure. Until this is done the
deployjob fails on the first push tomain, and the README docs badge 404s.Notes
widthis ignored; the changelog for 0.4.0 says it is honored. The new Limitations page follows the changelog. Worth aligning the README in a follow-up.🤖 Generated with Claude Code