{"id":21437313,"url":"https://github.com/mbinorg/mbin-docs","last_synced_at":"2025-03-16T23:25:03.628Z","repository":{"id":231756458,"uuid":"782615466","full_name":"MbinOrg/mbin-docs","owner":"MbinOrg","description":"Mbin Docs using Docusaurus","archived":false,"fork":false,"pushed_at":"2024-11-26T12:13:51.000Z","size":505,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-01-23T09:41:48.691Z","etag":null,"topics":["documentation","documentation-generator","mbin"],"latest_commit_sha":null,"homepage":"https://docs.joinmbin.org/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MbinOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-04-05T16:56:38.000Z","updated_at":"2024-11-26T12:13:56.000Z","dependencies_parsed_at":"2024-11-08T14:28:29.363Z","dependency_job_id":"3d4109aa-36e5-425f-abc7-7f5305135a1e","html_url":"https://github.com/MbinOrg/mbin-docs","commit_stats":null,"previous_names":["mbinorg/mbin-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MbinOrg%2Fmbin-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MbinOrg%2Fmbin-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MbinOrg%2Fmbin-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MbinOrg%2Fmbin-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MbinOrg","download_url":"https://codeload.github.com/MbinOrg/mbin-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243946180,"owners_count":20373003,"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":["documentation","documentation-generator","mbin"],"created_at":"2024-11-23T00:19:06.506Z","updated_at":"2025-03-16T23:25:03.606Z","avatar_url":"https://github.com/MbinOrg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mbin-Docs\n\nThis repo is for building and running the documentation website, that is hosted on [docs.joinmbin.org](https://docs.joinmbin.org). The documentation this is building is coming from the mbin repos [docs folder](https://github.com/MbinOrg/mbin/tree/main/docs)\n\nThe docs are built using [Docusaurus](https://docusaurus.io/) and [Redocusaurus](https://github.com/rohit-gohri/redocusaurus).\n\n### Installation\n\nFor running this site you need to have an [Mbin](https://github.com/mbinOrg/mbin) repository, where our docs are hosted. The update script takes care of copying over docs and images and generating an open-api json for generating the api docs.\n\nBy default the script assumes the mbin repo is in the same directory as this repo under the directory name `mbin`. If you want to use a different repo you can specify the path to the repo with the `-d` flag.\n\n```bash\nnpm ci\n./update_and_build.sh -d YOUR_MBIN_REPO\n```\n\nThe repo that is linked will by default fetch and pull changes from the main branch. If you want to use another branch you can specify that by `-b BRANCH`.\nIt will only build the docs when there were changes in the branch, if you want to force it to rebuild the docs add a `-f`.  \nUse the `-s` flag to skip the production build and only update the docs (useful for local development).\n\n### Local Development\n\n```bash\nnpm start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```bash\nnpm build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbinorg%2Fmbin-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbinorg%2Fmbin-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbinorg%2Fmbin-docs/lists"}