The docs are written with specified markdown format, the frontend system will parse them automatically.
- Clone this repo by
git clone https://github.com/omniedgeio/docs.git- Create a new branch from the main by
git checkout -b doc/articlename main- Create a markdown file as the format mentioned below in Docs or in the subfolder related
- Write your content accordingly, copy images you use to the
Imagesfolder - Push the branch to the repo by
git add . && git commit -am "doc():add article name" && git push origin doc/articlename- Create a Pull request from
https://github.com/omniedgeio/docs/pulls, and waiting for review.
Template docs:
---
title: The title of the article
description: The abstract of the article
route: The route of this article, like Doc / OTHERS
index: 5
thumbnail: path of the thumbnail picture
---
<!-- Content Start -->
# The Head
## The Second Head
<!-- Content End -->
-----
If you have more questions, feel free to [contact us](mailto:[email protected]).
If you have more questions, feel free to contact us.