# docs

**Repository Path**: agricultureiot/docs

## Basic Information

- **Project Name**: docs
- **Description**: 在线文档使用编写模板
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-08-28
- **Last Updated**: 2024-08-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 概述

> 本示例是在线文档模板，可直接下载本模板进行markdown编辑

---


## 实名认证
- 码云进行实名认证，**认证完在往下面看**

![image](images/20230914094445.png ':size=900')


## 本地预览
- 安装 node.js >= 12.22.12 ： https://nodejs.org/en/download/releases

```bash
# 安装docsify命令，如果本地不想预览可以不用安装
npm i docsify-cli -g

# 启动项目 浏览器 http://localhost:3000 即可预览
docsify serve ../docs
```

## 使用方式
- 不要改动index.html文件
- 把自己的markdown文件放到目录下，在sidebar.md中配置一下文件名称即可(也可以空格配置层级)




## 部署方式
- 文档代码提交gitee,使用自带的Gitee Pages服务，在代码顶部的服务菜单中

![image](images/20230906100141.png ':size=900')


## 切换风格
- 替换index.html中的css和js,十几种风格任意选
- 支持上百种风格切换，这里只只展示一种：https://jhildenbiddle.github.io/docsify-themeable/#/markdown

```html
  <!-- 删除 vue.min.css 和 docsify.min.js 替换如下css和js-->
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css" title="light">
  <link rel="stylesheet" href="assets/css/main-custom.css">
  <link rel="stylesheet" href="assets/css/button-custom.css">
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

```

## logo素材

- https://www.iconfont.cn/collections/detail?spm=a313x.user_detail.i1.dc64b3430.650a3a813N6X7D&cid=45869