1
0
Fork
You've already forked rescript-docs-gen
0
No description
  • Astro 47.9%
  • MDX 32.4%
  • JavaScript 16.8%
  • TypeScript 2.9%
2025年08月23日 10:10:08 +02:00
.vscode Initial commit from Astro 2025年08月21日 10:45:14 +02:00
public . 2025年08月22日 01:44:55 +02:00
src Use steps 2025年08月23日 00:30:38 +02:00
.editorconfig . 2025年08月22日 01:44:55 +02:00
.gitignore Initial commit from Astro 2025年08月21日 10:45:14 +02:00
.prettierrc . 2025年08月22日 01:44:55 +02:00
astro.config.mjs Add documentation and readme support 2025年08月23日 00:19:08 +02:00
LICENSE add mit license 2025年08月22日 02:47:35 +02:00
package.json Fix build 2025年08月23日 10:10:08 +02:00
pnpm-lock.yaml Fix build 2025年08月23日 10:10:08 +02:00
pnpm-workspace.yaml . 2025年08月22日 01:44:55 +02:00
README.md Add better docs on how to get started generating 2025年08月22日 02:52:04 +02:00
tsconfig.json Initial commit from Astro 2025年08月21日 10:45:14 +02:00

Rescript Documentation Generator

Built with Starlight

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.