From 417f379d4084098069afff0527041a7cd1b81439 Mon Sep 17 00:00:00 2001 From: govolokatliai Date: Wed, 21 Aug 2024 19:09:05 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E7=BD=91=E7=AB=99=E5=BC=80?= =?UTF-8?q?=E5=8F=91=E7=9A=84=E5=B7=A5=E4=BD=9C=E6=B5=81=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/devdocs/02-网站/02-开发组网站/02-开发组网站-概览.md | 8 +++++++- docs/devdocs/02-网站/02-开发组网站/03-开发组网站-内容.md | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/devdocs/02-网站/02-开发组网站/02-开发组网站-概览.md b/docs/devdocs/02-网站/02-开发组网站/02-开发组网站-概览.md index 8ccb558..26f4165 100644 --- a/docs/devdocs/02-网站/02-开发组网站/02-开发组网站-概览.md +++ b/docs/devdocs/02-网站/02-开发组网站/02-开发组网站-概览.md @@ -2,7 +2,13 @@ ## 技术 网站基于Docusaurus开发,一个静态网页生成的框架，尤其对于生成技术文档来说，它提供了一个美观，现代的前端界面，这个项目本身是一个react.js应用，生成网页时只要输入：`npm run build`便可以在build目录里构建网站的所有资源，以进一步部署，关于详细的配置，可以去看官方的文档：[文档连接](https://www.docusaurus.cn/docs/category/guides) ## 工作流程 -基本上，我们需要把markdown文件放在目录里面，系统就会根据目录的结构自动生成网页，但是我们必须写好配置文件，如果我们想自定义网站的外观的话，也需要好好研究一下配置文件，有关文档还在编写中 +基本上，我们需要把markdown文件放在目录里面，系统就会根据目录的结构自动生成网页，但是我们必须写好配置文件，如果我们想自定义网站的外观的话，也需要好好研究一下配置文件，有关文档还在编写中 \ +开发组网站的开发流程基本如下： +1. 将源代码仓库的最新版本拉取到本地，对仓库的内容进行修改，最终在本地的master分支上commit, +2. 运行`npm start`在`https://localhost:3000`上运行基于改动构建的预览版本 +3. 测试改动，确保一切正常后push到github上 +4. demo网站会自动根据github上的msater分支构建网页，构成开发组网站的预览版本 +5. 积累几个改动后，在本地运行`npm run deploy`将网页构建好推送给github上的`build`分支，网站服务器自动获取并更新，构成开发组网站的正式版本 ## 目录 所有的文档文件都储存在docs文件夹下\ 所有的公告文件都储存在blog文件夹下\ diff --git a/docs/devdocs/02-网站/02-开发组网站/03-开发组网站-内容.md b/docs/devdocs/02-网站/02-开发组网站/03-开发组网站-内容.md index 115983f..0cfb3da 100644 --- a/docs/devdocs/02-网站/02-开发组网站/03-开发组网站-内容.md +++ b/docs/devdocs/02-网站/02-开发组网站/03-开发组网站-内容.md @@ -16,6 +16,7 @@ - src文件夹存放了独立于文档和blog的静态页面 - docs文件夹存放了所有的文档（目前有wiki和开发组文档两个docs） - blog文件夹存放了可以显示在“公告”板块的文章 + 所有的文档都以Markdown格式书写（其实也可以用MDX格式）， ### 前缀 所有文件都有一个数字前缀，这是文章在成品网站中的顺序,文件请按照`order-filename.md`的格式命名