{"id":18519776,"url":"https://github.com/reasonml-community/bsdoc","last_synced_at":"2026-01-24T16:36:29.568Z","repository":{"id":56668085,"uuid":"160383249","full_name":"reasonml-community/bsdoc","owner":"reasonml-community","description":"📚 Documentation Generator for BuckleScript","archived":false,"fork":false,"pushed_at":"2020-10-27T15:01:15.000Z","size":200,"stargazers_count":46,"open_issues_count":9,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-25T23:24:42.103Z","etag":null,"topics":["bucklescript","docs","documentation","documentation-generator","reasonml"],"latest_commit_sha":null,"homepage":"https://reasonml-community.github.io/bsdoc","language":"Reason","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-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-04T16:00:57.000Z","updated_at":"2022-09-22T19:55:43.000Z","dependencies_parsed_at":"2022-08-15T23:00:28.944Z","dependency_job_id":null,"html_url":"https://github.com/reasonml-community/bsdoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml-community%2Fbsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml-community%2Fbsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml-community%2Fbsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reasonml-community%2Fbsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reasonml-community","download_url":"https://codeload.github.com/reasonml-community/bsdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239236659,"owners_count":19604912,"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":["bucklescript","docs","documentation","documentation-generator","reasonml"],"created_at":"2024-11-06T17:17:22.772Z","updated_at":"2025-10-31T22:30:29.462Z","avatar_url":"https://github.com/reasonml-community.png","language":"Reason","funding_links":[],"categories":["Reason"],"sub_categories":[],"readme":"# bsdoc\n\n\u003e Documentation Generation for BuckleScript projects\n\n[![npm](https://img.shields.io/npm/v/bsdoc.svg)](https://npmjs.org/package/bsdoc)\n[![Build Status](https://dev.azure.com/yawaramin/bsdoc/_apis/build/status/reasonml-community.bsdoc?branchName=master)](https://dev.azure.com/yawaramin/bsdoc/_build/latest?definitionId=5\u0026branchName=master)\n\nRead more in the docs: [BsDoc](https://reasonml-community.github.io/bsdoc)\n\n## Usage\n\nInstall in your project using `npm` or `yarn`:\n\n```sh\n$ yarn add bsdoc\n```\n\nAnd whenever you want to generate your docs you can run:\n\n```sh\n# Build your docs!\nMyProject $ yarn run bsdoc build MyProject\nyarn run v1.12.3\n$ ./node_modules/.bin/bsdoc build MyProject\ninfo: Compiling documentation for package \"MyProject\"...\ninfo: Generating .html files...\ninfo: Done ✅\n✨  Done in 0.58s.\n```\n\nAdditionally, to install the support files (default CSS and Javascript), you\ncan run:\n\n```sh\n# Create the support files\nMyProject $ yarn run bsdoc support-files\nyarn run v1.12.3\n$ ./node_modules/.bin/bsdoc support-files\ninfo: Copying support files (CSS, JS) into ./docs\ninfo: Done ✅\n✨  Done in 0.53s.\n```\n\n## Contributing\n\n`bsdoc` is developed as a Native Reason project, and is only possible thanks to\n`esy`, `dune`, and, naturally, `odoc`.\n\nIf you haven't installed Esy yet, follow the instructions in their web site:\nhttps://esy.sh\n\nAfter you have done that, you need only run `esy build` to get the project\nbootstrapped.\n\n## Installing on Linux/Windows\n\nUnfortunately I haven't gotten around publishing `bsdoc` for Linux/Windows, but if you have `npm` installed you can run:\n\n```sh\n$ esy build\n$ esy npm-release\n```\n\nAnd that'll get you an npm package that you can then install locally (or globally) in any of your projects. Be mindful that it'll only work for `bs-platform@6`+ projects!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freasonml-community%2Fbsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freasonml-community%2Fbsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freasonml-community%2Fbsdoc/lists"}