{"id":13711306,"url":"https://github.com/ethersphere/bee-docs","last_synced_at":"2025-04-05T11:11:03.607Z","repository":{"id":38457954,"uuid":"269049907","full_name":"ethersphere/bee-docs","owner":"ethersphere","description":"Documentation for the Swarm Bee Client. View at docs.ethswarm.org docs.ethswarm.org, contributions welcome!","archived":false,"fork":false,"pushed_at":"2025-03-26T14:09:36.000Z","size":180816,"stargazers_count":36,"open_issues_count":62,"forks_count":72,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-29T10:08:29.498Z","etag":null,"topics":["documentation","ethereum","swarm"],"latest_commit_sha":null,"homepage":"https://bee-docs-preview.netlify.app/","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/ethersphere.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":"2020-06-03T09:48:00.000Z","updated_at":"2025-03-24T11:46:45.000Z","dependencies_parsed_at":"2024-01-25T14:28:12.913Z","dependency_job_id":"bec6d05d-e55c-4d4c-9029-5c47d54ffefd","html_url":"https://github.com/ethersphere/bee-docs","commit_stats":null,"previous_names":[],"tags_count":240,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fbee-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/bee-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325693,"owners_count":20920714,"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","ethereum","swarm"],"created_at":"2024-08-02T23:01:06.807Z","updated_at":"2025-04-05T11:10:58.596Z","avatar_url":"https://github.com/ethersphere.png","language":"JavaScript","funding_links":[],"categories":["Projects"],"sub_categories":["Documentation"],"readme":"# Bee Documentation Website\n\nDocumentation for the [Swarm Bee Client](https://github.com/ethersphere/bee). View at [docs.ethswarm.org](https://docs.ethswarm.org).\n\n## Contributing\n\nPull Requests are welcome, but please read our [CODING](CODING.md) guide!\n\n### Node Version\n\nYou must use **node 18** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).\n\n### Installation\n\nAfter the initial cloning of the repo you need to run:\n\n```\nnpm ci\n```\n\nto download the exact revisions of the dependencies captured in\n`package-lock.json`.\n\nIf the dependencies are updated in `package.json`, or if you wish to\ntest with the latest revisions of the dependencies, then you should\nrun:\n\n```\nnpm install\n```\n\nand then consider pushing the updated `package-lock.json` to the\nrepository if everything works fine.\n\n### Local Development\n\n```\nnpm start\n```\n\nThis command starts a local development server and opens up a browser\nwindow. Most changes are reflected live without having to restart the\nserver.\n\n### Build\n\n```\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n\n### Note about lunr search plugin\n\nThe lunr search plugin relies on manual [swizzling](https://docusaurus.io/docs/next/swizzling), which ejects the SearchBar component from the theme to allow for customization. Upgrading the Docusaurus theme WILL NOT upgrade swizzled components. This means upgrading the theme could break the search bare. Therefore whenever you upgrade the theme, make sure to delete the old swizzleed SearchBar component at src/theme/SearchBar and swizzle it again using this command:\n\n```\nnpm run swizzle docusaurus-lunr-search SearchBar -- --eject --danger\n```\nSee the documentation for the above command and the plugin at its github repo [here](https://github.com/praveenn77/docusaurus-lunr-search).\n\n\n## Bumping Version\n\nDon't forget to find and replace the version number for the whole of the docs folder. \n\n## API Reference \n\nThe OpenAPI reference docs are compiled at build time from the OpenAPI yaml files in the `/openapi` directory using the [redocusaurus plugin](https://www.npmjs.com/package/redocusaurus) for Docusaurus. They must be manually updated to stay up to date with the [OpenAPI specs in the Bee repo](https://github.com/ethersphere/bee/tree/master/openapi).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbee-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fbee-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fbee-docs/lists"}