CodeCow/stack
1
0
Fork 0
mirror of https://github.com/stack-auth/stack.git synced 2026-06-04 21:04:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
a1c0dc76a6
stack/docs
History
Zai Shi a1c0dc76a6 improved doc clarity
2024-03-07 16:40:45 +08:00
..
docs improved doc clarity 2024-03-07 16:40:45 +08:00
src added documentation link to dashboard 2024-03-04 17:32:42 +08:00
static Added docs 2024-02-28 16:53:11 +01:00
.env Several small fixes on the dashboard 2024-03-04 14:29:29 +01:00
.gitignore Added docs 2024-02-28 16:53:11 +01:00
babel.config.js Added docs 2024-02-28 16:53:11 +01:00
docusaurus.config.js fixed github link 2024-03-04 20:11:41 +08:00
package.json Better clean script 2024-03-04 19:37:39 +01:00
pnpm-lock.yaml Added docs 2024-02-28 16:53:11 +01:00
README.md Added docs 2024-02-28 16:53:11 +01:00
sidebars.js Update documentation 2024-03-04 03:07:12 +01:00

README.md

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.