https://github.com/primihub/primihub-docs
PrimiHub document website
https://github.com/primihub/primihub-docs
federated-learning hacktoberfest mpc pir psi
Last synced: about 1 year ago
JSON representation
PrimiHub document website
- Host: GitHub
- URL: https://github.com/primihub/primihub-docs
- Owner: primihub
- Created: 2022-06-09T07:22:03.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T06:15:27.000Z (about 2 years ago)
- Last Synced: 2024-03-26T07:28:33.067Z (about 2 years ago)
- Topics: federated-learning, hacktoberfest, mpc, pir, psi
- Language: JavaScript
- Homepage: https://docs.primihub.com/
- Size: 13.9 MB
- Stars: 13
- Watchers: 5
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Primihub Docs
This is the source code for [PrimiHub Docs](https://docs.primihub.com/).
We really apprecitate it if you would contribute to the content or the theme. You can do your contribution as follows.
# Contribution
This site is built with [Docusaurus 2](https://docusaurus.io/).
Site 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.
## Prerequisite
This project requires Node.js to be v14.0.0 or higher. Install Node.js in your local machine if necessary.
## Run & Edit Locally
Clone the repo, then edit and run it locally.
```shell
yarn # install dependencies
yarn start # This command opens up a browser window and will apply your local changes without having to restart.
```
## Routing
Each route you browse at comes with a markdown file in this project at `/docs`.
For example, the file for is `/docs/developer-docs/roadmap.md`.
### Route with multiple pages
It 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.
## How to Insert an Image
1. Prepare your image files and place them in `/static/img` folder, e.g. `/static/img/xxx.jpeg`
2. Refer the image in markdown file with ``
## Meta data
Beside the content, please don't forget adding the following metadata at the header of a Markdown file:
```yaml
keywords: [case1, case2]
description: This is a brief introduction to the content
```
> The metadata will make the search engine index our content easily.
## Menu
Please update [sidebars.js](sidebars.js) if you want to add a new menu item.
## Localization
Please put translation items into the following JSON file if you want to add a translation for English:
```
i18n/en/docusaurus-plugin-content-docs/current.json
```
You could start it with a particular language with the following command:
```shell
yarn start --locale en
```