Add getting started docs
Lint / lint (push) Successful in 16s

This commit is contained in:
Julien Valverdé
2026-06-08 13:55:16 +02:00
parent 1292b9885a
commit 845aa193ba
39 changed files with 434 additions and 1431 deletions
+5 -29
View File
@@ -1,41 +1,17 @@
# Website
# effect-fc Docs
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```bash
yarn
```
The documentation site is built with Docusaurus.
## Local Development
```bash
yarn start
bun run --cwd packages/docs 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
```bash
yarn build
bun run --cwd packages/docs build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
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.
The static site is written to `packages/docs/build`.