Repository files navigation

This code is used to generatehttps://reasonml.github.io. It pulls in files fromdocs/ andwebsite/ to generate HTML files served on the site.

website/ contains the JS, CSS, images and other files (and some markdown files inblog which are separated fromdocs/; it's not too important).

cd website && npm install && npm run start to start the development server & watcher.

Don't usenpm run build. It's mostly for debugging.

In the end, we spit out normal HTML with all but a few critical JS dependencies removed, including ReactJS itself. It's a full static website: super lightweight, portable, unfancy, but good looking. And it works with JS turned off!

Two special files:

• sidebars.json: lists the sections.
• siteConfig.json: some header and i18n configs.

During your development, most changes will be picked up at each browser refresh. If you touch these two files orblog/, however, you'll have to restart the server to see the changes.

The entire site can be translated via theCrowdin project. This repo only has the canonical English documentation. Don't manually edit things ini18n/.

console.logs appear in your terminal! Since the site itself is React-free.

Changes from thesource branch are automatically picked intomaster branch by CI and then published.

cd website && npm install

For modifying the actual try playground source code, runnpm run bundle-try-playground:dev to start a watcher. Once you're done, runnpm run bundle-try-playground:prod once.

To build the actualbsReasonReact.js,refmt.js,stdlibBundle.js,reasonReactBundle.js:

You'll need to have this repository and theBuckleScript repository cloned. These will likely be next to each other in the directory structure.

1. Inside the BuckleScript repository, follow theSetup guide.

2. Follow theContributing to the BS Playground Bundle guide.

3. RunBS_PLAYGROUND=../../reasonml.github.io/website/playground/bs node scripts/repl.js

4. Inside thereasonml.github.io repository, runcd website && yarn

5. Then run,yarn prepare in the same place.

6. Finally, runnode setupSomeArtifacts.js

If this command fails, ping @chenglou in Discord.