This is the source code for PrimiHub Docs.
We really apprecitate it if you would contribute to the content or the theme. You can do your contribution as follows.
This site is built with Docusaurus 2.
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.
This project requires Node.js to be v14.0.0 or higher. Install Node.js in your local machine if necessary.
Clone the repo, then edit and run it locally.
yarn # install dependencies
yarn start # This command opens up a browser window and will apply your local changes without having to restart.
Each route you browse at https://docs.primihub.com/ comes with a markdown file in this project at /docs
.
For example, the file for https://docs.primihub.com/docs/developer-docs/roadmap is /docs/developer-docs/roadmap.md
.
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.
/static/img
folder, e.g. /static/img/xxx.jpeg
![image desc](/img/xxxx.jpeg)
Beside the content, please don't forget adding the following metadata at the header of a Markdown file:
keywords: [case1, case2]
description: This is a brief introduction to the content
The metadata will make the search engine index our content easily.
Please update sidebars.js if you want to add a new menu item.
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:
yarn start --locale en
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。