{"id":13905313,"url":"https://github.com/reasonml/reasonml.github.io","last_synced_at":"2025-05-07T10:35:07.541Z","repository":{"id":22784941,"uuid":"94266305","full_name":"reasonml/reasonml.github.io","owner":"reasonml","description":"Reason's documentation site","archived":false,"fork":false,"pushed_at":"2024-03-28T23:50:53.000Z","size":121442,"stargazers_count":330,"open_issues_count":50,"forks_count":401,"subscribers_count":20,"default_branch":"source","last_synced_at":"2024-04-13T17:08:00.883Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://reasonml.github.io","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reasonml.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-13T23:10:29.000Z","updated_at":"2024-08-07T00:28:49.451Z","dependencies_parsed_at":"2023-01-14T01:00:09.576Z","dependency_job_id":"1f9f03bc-3f44-476d-adc9-8a31d4945366","html_url":"https://github.com/reasonml/reasonml.github.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml%2Freasonml.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml%2Freasonml.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml%2Freasonml.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml%2Freasonml.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reasonml","download_url":"https://codeload.github.com/reasonml/reasonml.github.io/tar.gz/refs/heads/source","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252860330,"owners_count":21815499,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T23:01:13.627Z","updated_at":"2025-05-07T10:35:07.514Z","avatar_url":"https://github.com/reasonml.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Reason Website\n\nThis 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.\n\n`website/` contains the JS, CSS, images and other files (and some markdown files in `blog` which are separated from `docs/`; it's not too important).\n\n`cd website \u0026\u0026 npm install \u0026\u0026 npm run start` to start the development server \u0026 watcher.\n\nDon't use `npm run build`. It's mostly for debugging.\n\nIn 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!\n\nTwo special files:\n\n- `sidebars.json`: lists the sections.\n- `siteConfig.json`: some header and i18n configs.\n\nDuring 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.\n\n## Translations\n\nThe 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/`.\n\n## Debugging\n\n`console.log`s appear in your terminal! Since the site itself is React-free.\n\n## Building and Deploying\n\nChanges from the `source` branch are automatically picked into `master` branch by CI and then published.\n\n# Building the Playground\n\n```\ncd website \u0026\u0026 npm install\n```\n\nFor modifying the actual try playground source code, run `npm run bundle-try-playground:dev` to start a watcher. Once you're done, run `npm run bundle-try-playground:prod` once.\n\n## Building with custom BuckleScript/etc\n\nTo build the actual `bsReasonReact.js`, `refmt.js`, `stdlibBundle.js`, `reasonReactBundle.js`:\n\nYou'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.\n\n1. Inside the BuckleScript repository, follow the [Setup](https://github.com/BuckleScript/bucklescript/blob/master/CONTRIBUTING.md#setup) guide.\n\n2. Follow the [Contributing to the BS Playground Bundle](https://github.com/BuckleScript/bucklescript/blob/7.0.1/CONTRIBUTING.md#contributing-to-the-bs-playground-bundle) guide.\n\n3. Run `BS_PLAYGROUND=../../reasonml.github.io/website/playground/bs node scripts/repl.js`\n\n4. Inside the `reasonml.github.io` repository, run `cd website \u0026\u0026 yarn`\n\n5. Then run, `yarn prepare` in the same place.\n\n6. Finally, run `node setupSomeArtifacts.js`\n\nIf this command fails, ping @chenglou in Discord.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freasonml%2Freasonml.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freasonml%2Freasonml.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freasonml%2Freasonml.github.io/lists"}