https://github.com/omniedgeio/docs

https://omniedge.io/docs
https://github.com/omniedgeio/docs

Last synced: 3 months ago
JSON representation

https://omniedge.io/docs

• Host: GitHub
• URL: https://github.com/omniedgeio/docs
• Owner: omniedgeio
• License: gpl-3.0
• Created: 2022-05-24T00:48:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-07T10:12:33.000Z (over 2 years ago)
• Last Synced: 2024-08-01T20:52:51.450Z (6 months ago)
• Size: 63.5 KB
• Stars: 4
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - omniedgeio/docs - 08 star:0.0k fork:0.0k https://omniedge.io/docs (Others)

README

        
# OmniEdge Documentation

[https://omniedge.io/docs](https://omniedge.io/docs)

**The docs are written with specified markdown format, the frontend system will parse them automatically.** 

## How to contribute docs

1. Clone this repo by 

```bash

git clone https://github.com/omniedgeio/docs.git

```

3. Create a new branch from the main by

```bash

git checkout -b doc/articlename main

```

5. Create a markdown file as the format mentioned below in Docs or in the subfolder related

6. Write your content accordingly, copy images you use to the `Images` folder

7. Push the branch to the repo by 

```bash

git add . && git commit -am "doc():add article name" && git push origin doc/articlename

```

10. Create a Pull request from `https://github.com/omniedgeio/docs/pulls`, and waiting for review. 

## The format of the docs

Template docs:

```markdown

---

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

---

# The Head

## The Second Head

-----

If you have more questions, feel free to [contact us](mailto:[email protected]).

```

## Contributors

-----

If you have more questions, feel free to [contact us](mailto:[email protected]).