Skip to content

Repository files navigation

wiki

Shenanigan wiki

Current state

Production builds temporarily display a video-only coming-soon page while Docs V2 is in development. Run yarn start to work on the full docs with their sidebar and existing styling. Run yarn build and yarn serve to preview the production placeholder. Documentation routes are excluded from production output; blog generation stays disabled in both modes. See the V2 work index for open PRs, the restoration plan, and publishing checks. The placeholder is defined in src/pages/index.jsx.

The production page loops a muted, inline video selected by viewport orientation. The entire composition scales to the viewport in both dimensions, keeping all source content visible without black bars or repeat seams. Its proportions adapt to the screen rather than preserving a fixed aspect ratio. The loading image uses the same layout, and playback uses a single native video element. The files in static/media/coming-soon/ are served directly rather than bundled into JavaScript. Landscape keeps 1920×1080 resolution; portrait uses 720×1280. Both are H.264 MP4, 30 fps, encoded with CRF 25, the slow preset, yuv420p, no audio, and +faststart. Matching WebP first frames provide an immediate loading image.

Info

This website is built using Docusaurus 3, a modern static website generator.

Installation

Requires Node.js 20 or newer and Yarn Classic 1.22.22. Verified with Node.js 20.20.2. No OpenSSL compatibility flags are needed.

yarn install --frozen-lockfile

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

For a local server without opening a browser, or when port 3000 is occupied:

yarn start --no-open --host 127.0.0.1 --port 3107

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

About

Shenanigan wiki

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages