This is the repository for reasonml.org and is currently work in progress.
yarn # Initial build yarn bs:build yarn dev # Open localhost:3000
In case you want to run BuckleScript in watchmode:
yarn run bs:start
Build Index Data
We are parsing our content for specific index data (such as, all interesting
search terms we need for searching inside the
Belt docs). You can create your
index by running following command:
yarn run update-index
All the index data is stored in
index_data, but will not be tracked by git.
Make sure to build the index after a fresh clone, otherwise Next might not
build specific pages (file
index_data/x.json not found).
We try to verify our code examples inside markdown files as much as possible.
Currently we are using
scripts/test-examples.js to test all our example
codeblocks (those blocks marked with
After writing documentation, make sure to run this code before submitting a PR:
# Tests all files node scripts/test-examples.js # Or just a subset (glob pattern) node scripts/test-examples.js "pages/belt_docs/set-*.mdx"
Design / UX
Design mockups can be found here.
Be aware that some screen designs might still be work in progress, if you have any design / UX questions, either comment directly on the design tool as guest, or open an issue.
Build CSS seperately via
postcss (useful for debugging)
# Devmode postcss styles/main.css -o test.css # Production NODE_ENV=production postcss styles/main.css -o test.css
Check out our CONTRIBUTING.md for how to get started working on this project.