Skip to content
source
Go to file
Code

Latest commit

* Remove Reason Associaton & Hemnet from users of reason

The Reason Association is using ReScript, and Hemnet needs to be taken
down for legal / copyright reasons (wanted to aid @believer in getting this
change upstream)

* Update landing page

- Update marketing blocks
- Remove ReScript related quick start
- Remove unrelated examples section (these are all outdated ReScript projects)

* Update Installation instructions

Remove outdated and wrong installation instructions
and add an esy / hello-reason quickstart example.

* Update installation instructions

* Update editor plugins

* Extra goodies: remove mention of bsb-native

* Remove newcomer-examples / project-structure

These two pages were almost exclusively targeted to old BuckleScript
conventions, that aren't even up to date. Removing this info will help
not mixing up BuckleScript'isms with native development.

* Merge native sections with installation

* Fine tune frontpage copy

* Update FAQ

* Update articles and videos

* Remove community examples

Like the landing page, the examples are terribly outdated and don't
reflect modern Reason at all.

* Remove roadmap page

This page is terribly outdated as well

* Remove dead links on community events page

* Update sidebar for community pages

* Fix typo in installation

* add faq link in installation

* Improve FAQ copy

* Update faq

* Update installation

* Update JSX docs

- Added note on ReScript JSX docs for ReasonReact usage
- Removed ReasonReact / BuckleScript mentions
- Added ReveryUI as a framework using the JSX semantics

* Update external docs

* Make FAQ leaner

* Remove note on object page to non-existing section

* Remove broken links in "users-of-reason"

Some companies seem to be gone, and I couldn't find
any sign of being renamed / being acquired, so I removed
them.

* Undo (obsolete) addition for JavaScript

* Less detailed faq

* Update en.json
18dc62a

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Reason Website

This code is used to generate https://reasonml.github.io. It pulls in files from docs/ and website/ to generate html files served on the site.

website/ contains the JS, CSS, images and other files (and blog, which contains some markdown files too, these are separated from docs/, not too important).

cd website && yarn && yarn start to start the development server & watcher.

Don't use yarn build. It's mostly for debugging.

In the end, we spit out normal HTML, with all the JS dependencies (barring a few critical ones) removed, including ReactJS itself. It's a full, static website, super lightweight, portable, unfancy but good looking. Works with JS turned off too.

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 or blog/, however, you'll have to restart the server to see the changes.

Translations

The entire site can be translated via the Crowdin project. This repo only has the canonical english documentation. Don't manually edit things in i18n/.

Debugging

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

Building and Deploying

Changes from source branch are automatically picked into master branch by CI, then published.

Build the Playground

cd website && yarn

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

Building with custom BuckleScript/etc

To build the actual bsReasonReact.js, refmt.js, stdlibBundle.js, reasonReactBundle.js:

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

  1. Inside the BuckleScript repository, follow the Setup guide.

  2. Follow the BS Playground instructions, with these caveats:

  • Make sure the reason-react version in BuckleScript playground folder is the same as the one in this project
  • When calling cmij.exe, just pass the path to reason-react, e.g. ../jscomp/bin/cmij.exe -playground node_modules/reason-react/lib/ocaml
  • Run BS_PLAYGROUND=../../reasonml.github.io/website/playground/bs node scripts/repl.js
  1. Inside the reasonml.github.io repository, run cd website && yarn

  2. Finally, run node setupSomeArtifacts.js

If this command fails, ping @chenglou in Discord.

About

Reason's documentation site

Resources

License

Releases

No releases published

Packages

No packages published

Languages

You can’t perform that action at this time.