# doc-site

**Repository Path**: sower/doc-site

## Basic Information

- **Project Name**: doc-site
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-23
- **Last Updated**: 2023-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Other

## README

## 项目说明：
* 文档网站，主要包括项目文档和随笔整理。
* 项目配置在根目录`config.json`中

### 开发：
* Typora中图片设置 复制到指定路径，路径与配置文件`config.json`中`absImgPath` 保持一致
![img.png](./docs/imgs/img-setting.png)
* 使用Typora编辑好MD文档，并复制到`docs/项目`或`docs/随笔`目录下，运行`yarn run up-doc`，自动上传文档中使用的本地图片
* 根据配置文件中`updateSidebar`，决定是否覆盖已有侧边栏
* 输入`yarn run docs:dev`本地启动项目

### 本地部署（windows）：
1. 确保本地安装了nginx
2. 确保本地Windows安装了Git Bash环境
3. 修改deploy-local.sh中local_path为nginx安装位置根目录
4. 终端中运行`sh deploy-locla.sh`指令，部署文档到windows本地服务器

### 远程部署（linux）：
1. 确保远程Linux系统已经安装了nginx，并部署了Doc-Site项目。
2. 确保本地Windows安装了Git Bash环境
3. 修改deploy-remote.sh中remote_ip为实际服务器ip。
4. 终端中运行`sh deploy-remote.sh`指令，部署文档到远程服务器