SJF4J Website
The SJF4J documentation website, built with VitePress and published at sjf4j.org.
Local development
Use Node.js 22 (the version used by GitHub Actions).
bash
npm ci
npm run docs:devBuild the site and check internal links:
bash
npm run docs:build
npm run docs:previewProject structure
index.mdand.vitepress/theme/— homepage and custom componentsdocs/— documentation and feature guidesdocs/benchmarks.md— benchmark overview; detailed reports live in the SJF4J source repositorygenerator.md— current Schema-to-Java Generator landing pagepublic/— static assets,robots.txt, and AI discovery files.vitepress/config.mts— site navigation, metadata, and sitemapscripts/sync-readme.mjs— generatesdocs/getting-started.mdfrom the upstream README.github/workflows/— CI, README synchronization, and GitHub Pages deployment
Content maintenance
- Documentation is written in English. Keep Runtime and Compiled examples together where relevant.
- Keep JDBC Result Mapping separate from general Object Mapping.
- The SJF4J README is the source for
docs/getting-started.md. The scheduled sync workflow proposes changes by pull request; fix README content and links upstream rather than patching the generated page. - Link to upstream benchmark reports instead of maintaining a second copy.
- When renaming or retiring pages, update internal links and remove obsolete files, routes, and unused components; do not retain compatibility stubs.
Deployment
.github/workflows/deploy.yml builds and deploys the site from main to GitHub Pages. The custom domain and HTTPS configuration are managed in the repository's Settings → Pages.
All changes to main must be submitted through a pull request.