https://github.com/jacob-ebey/remix-ssg
A CLI for building static sites with Remix
https://github.com/jacob-ebey/remix-ssg
Last synced: about 1 year ago
JSON representation
A CLI for building static sites with Remix
- Host: GitHub
- URL: https://github.com/jacob-ebey/remix-ssg
- Owner: jacob-ebey
- Created: 2022-07-30T07:46:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-01T00:36:46.000Z (almost 4 years ago)
- Last Synced: 2025-04-01T20:09:52.903Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://remix-ssg.pages.dev
- Size: 350 KB
- Stars: 55
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remix SSG
Simple SSG for [Remix](https://remix.run/).
[Read the Docs](https://remix-ssg.pages.dev/docs)
# Docs
Deployed to multiple hosts:
- [Github Pages](https://remix-ssg.pages.dev)
- [Netlify](https://remix-ssg.netlify.app)
- [Vercel](https://remix-ssg.vercel.app)
## Quick Start
1. Initialize a new remix project:
```bash
npx create-remix@latest
```
Choose "Just the basics" and the "Remix App Server" when prompted.
1. Install `remix-ssg` and `serve` to serve the static assets:
```bash
npm install -D remix-ssg serve
```
1. Update your `package.json` `scripts` to use `remix-ssg` instead of `remix` and `serve` instead of `remix-serve`:
```json
{
"scripts": {
"build": "remix-ssg public",
"dev": "remix dev",
"start": "serve -l 3000 public"
}
}
```
1. Add a `getStaticPaths` export to your routes. For example `app/routes/index.tsx` may look like:
```tsx
export function getStaticPaths() {
return ["/"];
}
```