Skip to content
WIP Reason / BuckleScript documentation platform with intelligent design and UX
JavaScript OCaml CSS C++
Branch: master
Clone or download
cknitt and ryyppy Rewrite Belt intro. (#85)
* Rewrite Belt intro.

* Uncurry syntax.

* camlCase -> camelCase

* Links

* Add paragraph about string/date.

* Rewrite motivation section.

* Pipe first: link to jchavarri's blog post.

* Remove duplicate "instead".

* Set.Int.toArray output is already sorted.

* More links.
Latest commit 1011d1b Nov 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows switch to args Oct 25, 2019
bindings Adapt style for sidebar Oct 6, 2019
common Switch to tailwind based theming w/ CSS variables Oct 28, 2019
components Switch to tailwind based theming w/ CSS variables Oct 28, 2019
index_data Add empty index_data placeholder directory Sep 26, 2019
layouts Switch to tailwind based theming w/ CSS variables Oct 28, 2019
pages Rewrite Belt intro. (#85) Nov 8, 2019
scripts fix index extraction Oct 27, 2019
static Add bold mono font Oct 8, 2019
styles Switch to tailwind based theming w/ CSS variables Oct 28, 2019
.babelrc Initial commit Sep 17, 2019
.gitignore Add empty index_data placeholder directory Sep 26, 2019
.nowignore Initial commit Sep 17, 2019
CODE_OF_CONDUCT.md Add code of conduct (#38) Oct 1, 2019
CONTRIBUTING.md Add CONTRIBUTING.md (#39) Oct 1, 2019
LICENSE Initial commit Sep 17, 2019
README.md cleanup docs Oct 27, 2019
bsconfig.json Restructure design for major API page Oct 28, 2019
next.config.js Initial commit Sep 17, 2019
now.json Now: Stop github notifications Oct 2, 2019
package.json
postcss.config.js Initial commit Sep 17, 2019
tailwind.config.js Switch to tailwind based theming w/ CSS variables Oct 28, 2019
yarn.lock Upgrade bs-platform and gentype Oct 26, 2019

README.md

Contributor Covenant

reasonml.org

This is the repository for reasonml.org and is currently work in progress.

Setup

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).

Run Tests

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 re examples).

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.

Useful commands

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

Contributing

Check out our CONTRIBUTING.md for how to get started working on this project.

TLDR: Read and comply to our Code of Conduct; always make sure to have an issue assigned / create issues / join us in the ReasonML Discord #docs channel to find a good task to work on.

You can’t perform that action at this time.