scviva-tools-website

Marketing/landing site for scVIVA-Tools, built with Docusaurus. Structurally cloned from scvi-tools-site; content is specific to scviva-tools.

This site does not host the full manual — tutorials, user guide, and API reference live at scviva-tools.readthedocs.io (built from the scviva-tools package's own Sphinx docs). This site links out to them.

The intended domain, scviva-tools.org, has not been purchased/configured yet.

Local development

npm install
npm start       # local dev server with hot reload

Build

npm run build   # static output in build/
npm run serve   # serve the production build locally

Note: baseUrl is set for the eventual scviva-tools.org custom domain — deploying to plain GitHub Pages without a custom domain will need baseUrl changed to /scviva-tools-website/ (or a static/CNAME file added once the domain is live).

Tests

npm test        # runs `npm run build` then scripts/check-content.js content assertions
npm run lint    # prettier --check

scripts/check-content.js asserts that key content (model names, install commands, citations) actually made it into the built HTML for each page — it's a lightweight regression check, not a UI test.

Structure

• docusaurus.config.js — site configuration
• src/pages/ — homepage, Get Started, team, press, ecosystem
• src/theme/ — ported UI components (Hero, Features, TeamCard, IconLink)
• blog/ — blog posts

This site has no local search — @easyops-cn/docusaurus-search-local was evaluated and found incompatible with this project's docs: false setup (it crashes without the docs plugin); adding real search back would need a properly adapted SearchBar component, which was out of scope here.

Contributing

Open a PR editing the relevant page under src/pages/ or blog/. CI (.github/workflows/ci.yml) runs npm test and npm run lint on every push and PR.