Skip to content

docs: Docusaurus documentation site + GitHub Pages workflow - #13

Merged
NikPnevmatikos merged 1 commit into
mainfrom
docs/website
Sep 11, 2026
Merged

NikPnevmatikos merged 1 commit into
mainfrom
docs/website

Conversation

@NikPnevmatikos

Copy link
Copy Markdown
Owner

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 embeds example/App.tsx in Expo Snack on SDK 56 as a live playground. The folder is deliberately not an npm workspace member; it has its own package.json and lockfile.
  • .github/workflows/docs.yml: builds the site on pull requests that touch website/ (this PR will run it as a check), and builds + deploys to GitHub Pages on push to main.
  • README badge (root and packages/core) linking to https://nikpnevmatikos.github.io/Html-Renderer/.

Verified locally

  • npm run build in website/ succeeds with onBrokenLinks and onBrokenAnchors set to throw.
  • npm run typecheck in website/ passes.
  • Served the build and confirmed the Snack embed creates its iframe with sdkVersion=56.0.0 and platform=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 deploy job fails on the first push to main, and the README docs badge 404s.

Notes

  • The README still documents everything in full. Trimming it to install + quick start + links is a possible follow-up, left out here to keep the review focused.
  • The README's "Current limitations" says cell width is 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

- 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>
@NikPnevmatikos
NikPnevmatikos merged commit fe34f2c into main Sep 11, 2026
4 checks passed
@NikPnevmatikos
NikPnevmatikos deleted the docs/website branch September 11, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant