Oreon's documentation, powered by Docusaurus.

Find a file

ofluffydev 4e17a9b760 Fix docs for new init option		2024-11-02 02:08:52 -05:00
docs	Fix docs for new init option	2024-11-02 02:08:52 -05:00
src	init	2024-11-01 01:54:55 -05:00
static	Fix docs for new init option	2024-11-02 02:08:52 -05:00
.gitignore	init	2024-11-01 01:54:55 -05:00
babel.config.js	init	2024-11-01 01:54:55 -05:00
docusaurus.config.ts	init	2024-11-01 01:54:55 -05:00
package-lock.json	stupid fix for cloudflare	2024-11-01 02:01:39 -05:00
package.json	init	2024-11-01 01:54:55 -05:00
README.md	init	2024-11-01 01:54:55 -05:00
sidebars.ts	init	2024-11-01 01:54:55 -05:00
tsconfig.json	init	2024-11-01 01:54:55 -05: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.