https://github.com/thangngoc89/reasonml-docs
https://github.com/thangngoc89/reasonml-docs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thangngoc89/reasonml-docs
- Owner: thangngoc89
- License: mit
- Created: 2021-07-09T10:23:01.000Z (almost 4 years ago)
- Default Branch: source
- Last Pushed: 2021-07-13T01:07:03.000Z (almost 4 years ago)
- Last Synced: 2025-01-19T17:08:47.920Z (5 months ago)
- Language: JavaScript
- Size: 29.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://crowdin.com/project/reason). This repo only has the canonical english documentation. Don't manually edit things in `i18n/`.
## Debugging
`console.log`s 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](https://github.com/BuckleScript/bucklescript) repository cloned. These will likely be next to each other in the directory structure.
1. Inside the BuckleScript repository, follow the [Setup](https://github.com/BuckleScript/bucklescript/blob/master/CONTRIBUTING.md#setup) guide.
2. Follow the [BS Playground instructions](https://github.com/BuckleScript/bucklescript/tree/master/playground), 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`
3. Inside the `reasonml.github.io` repository, run `cd website && yarn`
4. Finally, run `node setupSomeArtifacts.js`
If this command fails, ping @chenglou in Discord.