1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-19 12:59:36 +02:00
AdventureLog/documentation
2024-08-24 23:20:50 -04:00
..
blog Add screenshots and better documentation 2024-08-01 21:06:50 -04:00
docs Custom registration disable message 2024-08-24 23:20:50 -04:00
src docs 2024-07-08 17:10:50 -04:00
static docs 2024-07-08 17:10:50 -04:00
.gitignore migration to new backend 2024-07-08 11:44:39 -04:00
babel.config.js migration to new backend 2024-07-08 11:44:39 -04:00
docusaurus.config.ts Add screenshots and better documentation 2024-08-01 21:06:50 -04:00
package.json migration to new backend 2024-07-08 11:44:39 -04:00
pnpm-lock.yaml migration to new backend 2024-07-08 11:44:39 -04:00
README.md migration to new backend 2024-07-08 11:44:39 -04:00
sidebars.ts migration to new backend 2024-07-08 11:44:39 -04:00
tsconfig.json migration to new backend 2024-07-08 11:44:39 -04:00

Website

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

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

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

Deployment

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.