cupcakearmy/memoir
1
0
Fork 0
mirror of https://github.com/cupcakearmy/memoir.git synced 2024-12-21 23:56:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
2 Commits 1 Branch 0 Tags 686 KiB
JavaScript 80.8%
TypeScript 19.2%
178501233f
Go to file
cupcakearmy 178501233f
feat: deploy to pages
2023-02-19 13:39:16 +01:00
.github feat: deploy to pages 2023-02-19 13:39:16 +01:00
docs feat: init 2023-02-19 13:34:28 +01:00
src feat: init 2023-02-19 13:34:28 +01:00
static feat: init 2023-02-19 13:34:28 +01:00
.gitignore feat: init 2023-02-19 13:34:28 +01:00
babel.config.js feat: init 2023-02-19 13:34:28 +01:00
docusaurus.config.js feat: init 2023-02-19 13:34:28 +01:00
package.json feat: init 2023-02-19 13:34:28 +01:00
pnpm-lock.yaml feat: init 2023-02-19 13:34:28 +01:00
README.md feat: init 2023-02-19 13:34:28 +01:00
sidebars.js feat: init 2023-02-19 13:34:28 +01:00
tsconfig.json feat: init 2023-02-19 13:34:28 +01:00

README.md

Website

This website is built using Docusaurus 2, 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.