Repository navigation
feat(docs): Next.js docs site with online playground - #2
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NH5YqLdEWZQ4vnZ1Hdq8L3
…ating empty files Happens when the library is bundled (e.g. by Next.js) and its templates folder is not next to the code. Also make bin/cli.mjs executable. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NH5YqLdEWZQ4vnZ1Hdq8L3
- / landing, /docs (rendered from README.md), /playground: edit/upload/URL/examples spec input, all options, file tree + highlighted viewer, copy, download a file or everything as .zip, config/CLI snippet, shareable URL, light/dark, mobile - POST /api/generate on Vercel: option whitelist, JSON/YAML parsing with size and complexity limits, SSRF-safe URL download (DNS pinning, redirect checks, private ranges blocked), timeouts, rate limit - vercel.json, deploy guide in docs/README.md, CI job (typecheck, unit, build, trace check, Playwright e2e) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NH5YqLdEWZQ4vnZ1Hdq8L3
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NH5YqLdEWZQ4vnZ1Hdq8L3
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Vercel status failed on The The most likely cause is that the commits on this branch are authored by To check and unblock:
The GitHub Actions jobs ( Generated by Claude Code |
Summary
Replaces the markdown-to-html
docs/folder with a Next.js 16 app (deployable on Vercel, Root Directory =docs) that has a landing page, the documentation and an online playground.Pages
/– landing: install command, features, code example./docs– rendered at build time from the rootREADME.md(single source of truth): section sidebar, "On this page" TOC with scrollspy, anchor links, shiki-highlighted code, scrollable tables./playground– spec from editor (JSON/YAML, CodeMirror), URL, file upload (drag & drop) or bundled examples (Petstore, Swagger 2, minimal); every playground option grouped with descriptions; generate via button / Ctrl+Enter / auto; file list + highlighted viewer; copy, download a file or everything as.zip; "Show config" (config file / CLI command); shareable URL; localStorage persistence; light/dark; mobile layout.POST /api/generate(docs/lib/server/*)output: false,silent: trueforced.$refs rejected.GENERATE_RATE_LIMIT), friendly errors with proper status codes (400/413/415/422/429/500).../distat runtime (bundling it broke template lookup);next.config.tstracesdist, templates, the oxfmt native binding and the library's runtime deps.Library
bin/cli.mjsmade executable.CI
main– the workflow targetedmaster, so it never ran on this repo.docsjob: typecheck, unit tests,next build, route trace check, Playwright e2e.Deploy (manual)
Import the repo on Vercel with Root Directory
docs;docs/vercel.jsonbuilds the library first. Adding a Vercel Firewall rate-limit rule is recommended. Seedocs/README.md.Test plan
npm test(810 tests),tsc,oxlint,fmt:check, buildnpm run typecheck,npm test(184 unit tests: validation, SSRF classifier & fetcher, handler, parallel isolation),next buildnpm run test:e2e: 22 Playwright tests on Chromium (landing, docs TOC/highlighting, playground generate → view → copy → download → modular → zip, errors, upload limits, theme, mobile no horizontal scroll)🤖 Generated with Claude Code
https://claude.ai/code/session_01NH5YqLdEWZQ4vnZ1Hdq8L3
Generated by Claude Code