{"id":18554057,"url":"https://github.com/primihub/primihub-docs","last_synced_at":"2025-04-09T23:30:56.451Z","repository":{"id":37758949,"uuid":"501547090","full_name":"primihub/primihub-docs","owner":"primihub","description":"PrimiHub document website ","archived":false,"fork":false,"pushed_at":"2024-03-26T06:15:27.000Z","size":14580,"stargazers_count":13,"open_issues_count":4,"forks_count":25,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-03-26T07:28:33.067Z","etag":null,"topics":["federated-learning","hacktoberfest","mpc","pir","psi"],"latest_commit_sha":null,"homepage":"https://docs.primihub.com/","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/primihub.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}},"created_at":"2022-06-09T07:22:03.000Z","updated_at":"2024-03-26T07:28:34.123Z","dependencies_parsed_at":"2023-10-11T07:53:31.692Z","dependency_job_id":"1e3981d7-11f1-44c7-9ad7-7c8ec583e8d1","html_url":"https://github.com/primihub/primihub-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/primihub%2Fprimihub-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/primihub%2Fprimihub-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/primihub%2Fprimihub-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/primihub%2Fprimihub-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/primihub","download_url":"https://codeload.github.com/primihub/primihub-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223416302,"owners_count":17141809,"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":["federated-learning","hacktoberfest","mpc","pir","psi"],"created_at":"2024-11-06T21:19:36.861Z","updated_at":"2024-11-06T21:19:37.416Z","avatar_url":"https://github.com/primihub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Primihub Docs\n\nThis is the source code for [PrimiHub Docs](https://docs.primihub.com/).\n\nWe really apprecitate it if you would contribute to the content or the theme. You can do your contribution as follows.\n\n# Contribution\n\nThis site is built with [Docusaurus 2](https://docusaurus.io/).\n\nSite content is written in Markdown format located in `/docs`. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.\n\n## Prerequisite\n\nThis project requires Node.js to be v14.0.0 or higher. Install Node.js in your local machine if necessary.\n\n## Run \u0026 Edit Locally\n\nClone the repo, then edit and run it locally.\n\n```shell\nyarn # install dependencies \nyarn start # This command opens up a browser window and will apply your local changes without having to restart.\n```\n\n## Routing\n\nEach route you browse at \u003chttps://docs.primihub.com/\u003e comes with a markdown file in this project at `/docs`.\n\nFor example, the file for \u003chttps://docs.primihub.com/docs/developer-docs/roadmap\u003e is `/docs/developer-docs/roadmap.md`.\n\n### Route with multiple pages\n\nIt will generate a default index page for a route which contains sub files. You need to create a `_category_.json` file in route folder. See `/docs/developer-docs/core-concept` for more details.\n\n## How to Insert an Image\n\n1. Prepare your image files and place them in `/static/img` folder, e.g. `/static/img/xxx.jpeg`\n2. Refer the image in markdown file with `![image desc](/img/xxxx.jpeg)`\n\n## Meta data\n\nBeside the content, please don't forget adding the following metadata at the header of a Markdown file:\n\n```yaml\nkeywords: [case1, case2]\ndescription: This is a brief introduction to the content\n```\n\n\u003e The metadata will make the search engine index our content easily.\n\n## Menu\n\nPlease update [sidebars.js](sidebars.js) if you want to add a new menu item.\n\n## Localization\n\nPlease put translation items into the following JSON file if you want to add a translation for English:\n\n```\ni18n/en/docusaurus-plugin-content-docs/current.json\n```\n\nYou could start it with a particular language with the following command:\n\n```shell\nyarn start --locale en\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprimihub%2Fprimihub-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprimihub%2Fprimihub-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprimihub%2Fprimihub-docs/lists"}