Skip to content

README.md

Latest commit

 

History

History
71 lines (45 loc) · 1.71 KB

README.md

File metadata and controls

71 lines (45 loc) · 1.71 KB
Raw

rescript-react-native.github.io

Website for rescript-react-native

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

Requires Node.js 18+ (see .node-version).

Source lives on the src branch. GitHub Pages serves the built site from main.

Installation

npm install

Local Development

npm start

This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory.

Deployment

Automatic (recommended)

Push to the src branch (or run the workflow manually). GitHub Actions builds the site and publishes build/ to main (GitHub Pages).

Workflow: .github/workflows/ci.yml

Manual

npm run deploy

Requires push access to the repo (SSH recommended). Optional overrides:

GIT_DEPLOY_REPO=git@github.com:rescript-react-native/rescript-react-native.github.io.git \
GIT_USER_NAME="Your Name" \
GIT_USER_EMAIL="you@example.com" \
npm run deploy

Do not use docusaurus deploy / a gh-pages branch for this repo — Pages is configured on main.

Contribute

Read the contribution guidelines before contributing.

Code of Conduct

We want this community to be friendly and respectful to each other. Please read our full code of conduct so that you can understand what actions will and will not be tolerated.