Git Product home page Git Product logo

aisuda-docs's Introduction

爱速搭文档

文档基于 https://docusaurus.io/ 编译

本地预览

yarn install
yarn start

创建或新增文档

创建或删除文档除了要在 docs 下面新增对应 md 文件外,需要修改 sidebars.js 文件,这个是文档目录

编写文档

话术规范

  • 多章节写作,分为:概述、前置条件、注意事项、常见问题、相关 API 等
  • 句子采用动宾结构,例如:创建流程
  • 最后一步必须要给出能够查看的结果

章节标题

文档名称作为一级标题,内容中的目录要从二级标题开始,即 ##标题

引用图片

需要的图片全部存放到 static/img 目录,以文档的路径为图片文件夹路径,存放后,文档内容可以直接引用,引用时,只写/img/xxx/xx/xx.png 路径即可访问。

引用文档

文档间的跳转链接使用相对地址,比如 [私有部署安装](../私有部署/私有部署安装)

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.