Marvellous Codeworks Knowledge Base

Official documentation for the Marvellous Codeworks projects, available at kb.marvellouscode.works.

The site is built with Docusaurus and covers:

• Projects: The Great-er Tab Discarder, The Marvellous Suspender and logdrop, each with a stable and a next version of its documentation.
• Welcome page: who we are, contributing, license and support.
• What's New: release notes and announcements.

Repository layout

Path	Content	URL
docs/	Welcome page	/docs/intro
projects/<Project>/	Project documentation, Next version (previews and upcoming changes)	/docs/<Project>/next/...
<project>_versioned_docs/	Project documentation, stable version (latest release)	/docs/<Project>/...
blog/	What's New posts (YYYY-MM-DD-name/index.md)	/blog/...
src/	Custom pages, components and theme overrides
static/	Images and static files	/img/...

Do not edit <project>_versioned_docs/ and <project>_versioned_sidebars/ by hand: they are generated by Publish-ProjectDocs.ps1.

Project documentation versions

Each project keeps exactly two versions of its documentation:

• Stable: the latest release (Chrome Web Store for the extensions, GitHub release for logdrop), served at /docs/<Project>/. It is the default.
• Next: what is coming in the next release, served at /docs/<Project>/next/ with an "unreleased" banner. Useful for people running test builds or previews.

Older versions are not kept. Write and update the documentation in projects/<Project>/ (Next). After publishing a release, promote Next to stable:

.\Publish-ProjectDocs.ps1 -Project TMS -Version 9.1.0

The script removes the previous stable snapshot and creates the new one from projects/<Project>/. Commit the result.

docs/ and the blog are not versioned: what is merged into main goes online right away.

Links between projects live in different docs instances, so use absolute routes (/docs/TMS/overview) instead of relative .md paths. Links inside the same project stay relative.

Local development

Requires Node.js 22 (the version used by the deploy workflow).

npm ci          # install dependencies
npm start       # dev server with live reload on http://localhost:3000
npm run build   # production build in ./build (fails on broken links)
npm run serve   # serve the production build locally

Run npm run build before pushing: it catches broken links and MDX errors that the dev server may not report.

Admonitions with a title use the bracket syntax, :::tip[Title]. The old :::tip Title form is not supported (the site enables the Docusaurus v4 future flags).

Deployment

Every push to main runs .github/workflows/deploy.yml: it builds the site and publishes it to GitHub Pages with actions/upload-pages-artifact and actions/deploy-pages. The custom domain kb.marvellouscode.works is configured in the repository Pages settings.

Search is provided by Algolia DocSearch, comments on blog posts by Waline.

License

• Documentation (the Markdown content and screenshots of docs/, projects/, *_versioned_docs/ and blog/): Creative Commons Attribution 4.0 International (CC BY 4.0). You can reuse and adapt it, also commercially, as long as you credit the source with a link to kb.marvellouscode.works.
• Code (site source and scripts): MIT.
• Code excerpts from the projects keep the license of the project they come from: GPL-2.0 for The Marvellous Suspender and The Great-er Tab Discarder, AGPL-3.0 for logdrop. The projects themselves are not covered by this repository's licenses.
• Names and logos (Marvellous Codeworks, TMS, TGD, logdrop, static/img/MarvellousCodeworks_Logo.png, the suspendy-guy artwork): not covered by either license, all rights reserved. Third-party icons and images keep their own licenses.

Feedback

Found a mistake or have a suggestion? Open an issue.