fosrl/docs
1
0
Fork 0
mirror of https://github.com/fosrl/docs.git synced 2025-05-12 21:30:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Documentation for all Fossorial projects
17 commits 2 branches 0 tags 12 MiB
MDX 68.8%
TypeScript 28.3%
CSS 2.9%
Find a file
Owen Schwartz b38b4fb0b4
Format; add gerbil config notes
2025-01-03 20:37:04 -05:00
.vscode Initial site deploy 2025-01-01 17:46:59 -05:00
packages/docusaurus Format; add gerbil config notes 2025-01-03 20:37:04 -05:00
stacks Remove boilerplate and add initial quickstart 2025-01-01 18:17:24 -05:00
.gitignore clean up formatting a bit and add components overview 2025-01-02 17:57:30 -05:00
cdk.context.json Initial site deploy 2025-01-01 17:46:59 -05:00
package.json update wildcard docs 2025-01-03 20:09:48 -05:00
pnpm-workspace.yaml Initial site deploy 2025-01-01 17:46:59 -05:00
README.md Initial site deploy 2025-01-01 17:46:59 -05:00
sst.config.ts Initial site deploy 2025-01-01 17:46:59 -05:00
tsconfig.json Initial site deploy 2025-01-01 17:46:59 -05: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.