mirror of https://github.com/plexusorg/Website.git synced 2024-12-27 18:24:14 +00:00

Read-only mirror of Plexus website.

Find a file

Telesphoreo bc9cc9dbd4 Upgrade dependencies and add more about modules		2024-12-15 15:08:01 -06:00
docs	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
src	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
static	Huge documentation update	2024-12-02 12:41:26 -06:00
.gitignore	Revamp website with new Docusaurus version	2024-11-30 14:00:25 -06:00
.pnp.cjs	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
.pnp.loader.mjs	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
docusaurus.config.ts	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
package-lock.json	Initial Docusaurus Update	2024-11-30 19:31:24 +00:00
package.json	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00
README.md	Huge documentation update	2024-12-02 12:41:26 -06:00
sidebars.ts	Add information on NickMiniMessage	2024-12-02 15:00:34 -06:00
tsconfig.json	Huge documentation update	2024-12-02 12:41:26 -06:00
yarn.lock	Upgrade dependencies and add more about modules	2024-12-15 15:08:01 -06:00

Website

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

$ yarn

$ yarn start

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

$ yarn build

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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.