Giter Club home page Giter Club logo

docs's Introduction

RuyiSDK docs

文档包括RuyiSDK的总体介绍和各个组成部分的介绍和使用方法。

关于docs仓库

技术

docs仓库采用vitepress技术将Markdown格式的文档自动生成为web页面,结合github-pages 设置,能够自动将文档更新进行发布。

仓库目录介绍

  • docs : Markdown文档;采用分级管理。
  • .vitepress/config.mts : 目录索引定义。

贡献文档

欢迎大家一起参与RuyiSDK文档贡献。贡献方法:

  1. fork 本仓库;
  2. 在docs/docs/zh 目录下按需新建目录和markdown文档,或者修改已有的markdown文档;
  3. 修改docs/docs/.vitepress/config.mts 文档调整目录;
  4. 提交修改并创建pull request将文档贡献提交到docs仓库,等待仓库管理员审核合入;
  5. pr被合入后大约几十秒或几分钟后,访问 https://ruyisdk.github.io/docs 检查网页是否更新。

访问docs网站

网址:https://ruyisdk.github.io/docs

docs's People

Contributors

xijing21 avatar weilinfox avatar sebastianhayashi avatar mollybuild avatar trdthg avatar pz9115 avatar chunyuliao avatar archfeh avatar felixonmars avatar mengzhuo avatar xen0n avatar geasscore avatar lazyparser avatar z572 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.