Code Monkey home page Code Monkey logo

sa-doc's Introduction

介绍


sa-doc是什么?

一个基于markdown的接口文档编写工具

  • 基础框架基于:docsify
  • 书写格式参考:apidoc
  • 根据markdown格式编写api接口文档,写时方便
  • 自动将markdown格式转换为表格形式,看时方便

获取最新代码

需求提交

贡献代码

  1. 在github上fork一份到自己的仓库
  2. clone自己的仓库到本地电脑
  3. 在本地电脑修改、commit、push
  4. 提交pr(点击:New Pull Request)
  5. 等待合并

建议贡献的地方

  • 修复源码现有bug,或增加新的实用功能
  • 完善在线文档,或者修复现有错误之处
  • 如果更新实用功能,可在文档友情链接处留下自己的推广链接

sa系列其他工具

交流群

QQ交流群:782974737 点击加入

扫码加群

sa-doc's People

Contributors

click33 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.