# XCXH_bangzhu

**Repository Path**: jinxin168/xcxh_bangzhu

## Basic Information

- **Project Name**: XCXH_bangzhu
- **Description**: 一个开发文档制作系统，纯静态网页，实例(鑫程序化交易系统帮助文件)
- **Primary Language**: HTML
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 0
- **Created**: 2022-01-09
- **Last Updated**: 2025-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 开发文档帮助文档制作

## README


<span style="font-size: 28px; font-weight: bold;">目录</span>
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->

<!-- code_chunk_output -->
 
- [1、介绍](#1-介绍)
- [2、文档编写工具](#2-文档编写工具)
- [3、效果展示与测试](#3-效果展示与测试)
- [4、使用说明](#4-使用说明)
  - [4.1、文档目录结构](#41-文档目录结构)
  - [4.2、Markdown插件安装方法](#42-markdown插件安装方法)
  - [4.3、帮助文档目录设计](#43-帮助文档目录设计)
  - [4.4、单个文档制作](#44-单个文档制作)
  - [4.5、自动生成的单个html修改](#45-自动生成的单个html修改)

<!-- /code_chunk_output -->
***


### 1、介绍
一个开发文档制作系统，全静态，操作简单高效，可全局搜索。实例:鑫程序化交易系统帮助文件

### 2、文档编写工具
1、需用用vscode编辑器 + Markdown Preview Enhanced插件

2、Markdown 编写文档

3、<a href="https://blog.csdn.net/NSJim/article/details/89697630?" target='_blank' style="font-size:16
px;color:red;" >大神级Markdown文档编写教程</a>

***
### 3、效果展示与测试

<a href="http://cxh-jy.gnway.cc/" target='_blank' style="font-size:16
px;color:red;" >鑫程序化帮助文档展示连接</a>

效果图1：
![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/效果图1.png)

效果图2：
![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/效果图2.png)

***

### 4、使用说明

开发方法必做：下载，解压，在vscode中打开进行开发。

#### 4.1、文档目录结构

![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/目录结构介绍.png)

***

#### 4.2、Markdown插件安装方法

![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/文档开发插件安装与导出html.png)
***

#### 4.3、帮助文档目录设计

![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/目录htm介绍.png)

右侧目录尾部：
![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/目录htm尾部介绍.png)
***


#### 4.4、单个文档制作

![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/单个文档具体编写方法.png)

***

#### 4.5、自动生成的单个html修改

![在这里插入图片描述](/鑫程序化交易系统帮助/img/帮助文档开发/修改自动生成的html.png)