Name		Name	Last commit message	Last commit date
parent directory ..
blog		blog
docs		docs
og-image		og-image
src		src
static		static
unversioned		unversioned
versioned_docs/version-9.x		versioned_docs/version-9.x
versioned_sidebars		versioned_sidebars
.gitignore		.gitignore
.npmrc		.npmrc
README.md		README.md
babel.config.js		babel.config.js
docusaurus.config.js		docusaurus.config.js
docusaurus.preferredTheme.js		docusaurus.preferredTheme.js
docusaurus.twitterReload.js		docusaurus.twitterReload.js
docusaurus.typedoc.js		docusaurus.typedoc.js
global.d.ts		global.d.ts
min-light-with-diff.json		min-light-with-diff.json
package.json		package.json
sidebars.js		sidebars.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
types.d.ts		types.d.ts
vercel.json		vercel.json
versions.json		versions.json

README.md

Website

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

pnpm install

pnpm dev

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

It also starts open graph image generation on port 3001.

pnpm build

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

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.

We use @vercel/og-image for dynamic open graph image generation. They are deployed on the edge from the /og-image project.

To use the dynamic images, we override the default Docusaurus theme using swizzling. You can find these overrides in src/theme/**.

To play with them locally go the og-image folder and run pnpm dev.