The website of TissUUmaps, a GPU-accelerated web application for visualizing, annotating and sharing spatial biology data. It is built with Docusaurus and deployed to https://tissuumaps.github.io/.
The website hosts the TissUUmaps application and its documentation, both versioned by MAJOR.MINOR line. The documentation is written in the TissUUmaps repository; changes to it go there. This repository holds the rest of the website.
Most pages are Markdown files that can be edited on GitHub in the browser, through their "Edit this page" link.
| Page | File |
|---|---|
| Gallery | one folder per project in gallery/ |
| Getting started | src/pages/getting-started.mdx |
| About | src/pages/about.mdx |
| Documentation | docs/ in the TissUUmaps repository |
The Markdown pages can use a few components for their layout, such as <Steps>, <Box>, <Publication> or <Logo>, without an import (see src/components/markdown). Image paths start with /, from static/. The landing page is src/pages/index.tsx.
On every application release, the TissUUmaps release workflow pushes the released docs to releases/<line>/:
release.jsonholds the releasedversion, e.g.{ "version": "4.1.2" }.docs/holds the docs, including the API docs generated by typedoc.
Every push to main deploys the website.
Before the build, scripts/prepare.mts turns the released lines into Docusaurus versions.
It also downloads their apps from the TissUUmaps releases, served under app/<line>/.
A prerelease line is only shown while it is ahead of the latest stable line.
To build the released versions locally (downloading the apps needs gh):
pnpm install
pnpm run prepare:site # or: pnpm run prepare:site --skip-apps
pnpm run build && pnpm run serveClone this repository next to a TissUUmaps checkout and generate the API docs there:
cd ../TissUUmaps
pnpm install
pnpm run build:packages && pnpm run build:apidocsThen start the website with the TissUUmaps docs as the current version:
pnpm install
TISSUUMAPS_DOCS=../TissUUmaps/docs pnpm run startMost changes, including changes to the TissUUmaps docs, are reflected live. The preview shows the TissUUmaps docs as "Next", next to any prepared released versions.
Continuous integration runs these on every pull request:
pnpm run fmt:check # formatting (prettier)
pnpm run lint # linting (ESLint)
pnpm run typecheck # type checking
pnpm run test # tests of scripts/prepare.mtsPre-commit hooks (husky and lint-staged) lint and format the staged files.
Contributions are always welcome! See the TissUUmaps contributing guidelines and please adhere to its Code of Conduct.
The website is licensed under the MIT License.