No description
| .vscode | Initial commit from Astro | |
| public | . | |
| src | Use steps | |
| .editorconfig | . | |
| .gitignore | Initial commit from Astro | |
| .prettierrc | . | |
| astro.config.mjs | Add documentation and readme support | |
| LICENSE | add mit license | |
| package.json | Fix build | |
| pnpm-lock.yaml | Fix build | |
| pnpm-workspace.yaml | . | |
| README.md | Add better docs on how to get started generating | |
| tsconfig.json | Initial commit from Astro | |
Rescript Documentation Generator
Learn how to generate a documentation website just like this one!
mkdir -p ./src/data/file
npx rescript-tools@0.6.6 doc <my_project>/src/File.res > ./src/data/file/File.json
pnpm install
pnpm run dev
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.