有编程基础者

当您阅读到这里时，我们相信您已经具备了一定的编程基础，或者至少对计算机环境有一定的了解。如果您对计算机环境不熟悉，我们建议您先学习一些基础知识，例如如何使用命令行 (opens new window)、如何使用 Git 和 GitHub (opens new window)、如何使用 Markdown等。这些知识将帮助您更好地理解我们的文档库。

在开始之前，需要保证您已经成为我们的文档库的贡献者。如果您还没有成为我们的贡献者，请联系我们weithurd@icloud.com（并随信携带您的github账户），我们将尽快为您开通权限。

技能要求

熟悉 npm 包管理工具，用于安装和管理文档所需的依赖项。

熟悉 Git 版本控制系统，用于协作开发和管理代码。

熟悉 Markdown 格式，用于编写和编辑文档文章。

了解 VuePress 文档构建工具，用于在本地预览文档。

项目搭建

我们的文档使用 VuePress 构建，这是一个基于 Vue.js 的静态网站生成器。以下是你需要做的步骤：

首先，确保你的计算机已经安装了 Node.js。你可以在 https://nodejs.org 下载和安装 Node.js。(我使用的版本为node v14.20.0; npm v6.14.17)

克隆我们的文档仓库到本地。使用以下命令在你喜欢的目录下执行：

git clone https://github.com/shallvtalk/ClinicalTrialInfo.git

进入文档目录：

// 如果已经在这个文件夹内了则跳过此步骤
cd ClinicalTrial

注意

你此时的分支应该默认为 deploy_branch ，这是为了 vercel 持续集成而做的妥协。如果您希望编辑文档，应该切换分支到 master。

安装项目所需的依赖项。运行以下命令：

npm install

运行开发服务器，以便在本地预览文档。执行以下命令：

npm run dev

这将启动开发服务器，并在本地生成一个临时的网址，你可以在浏览器中打开它以查看文档的实时预览。

在浏览器中打开生成的临时网址，你将看到文档的初始内容。

---

编辑和新建文件

为了编辑和新建文档文章，你可以按照以下步骤操作：

打开你最喜欢的文本编辑器，确保它支持 Markdown 格式。

导航到文档目录下的 docs 文件夹。这是存放文档文章的位置。这可能需要一些vuepress的基础知识，如果您对此不熟悉，可以参考这里 (opens new window)。

在 docs 文件夹中，你可以找到已存在的 Markdown 文件，这些文件对应文档中的不同页面。你可以编辑这些文件来更新现有内容。

如果你想新建一个文档文章，只需在 docs 文件夹中创建一个新的 Markdown 文件，并使用 Markdown 格式编写文章内容。

提示

为了确保内容的准确性，我们非常建议您同步将参考文献的链接维护到ClinicalTrial/docs/04.资源/01.资源.md下，并且在您的文档中以链接的形式指向这些参考文献。

警告

请不要在您的文档中谈论不适宜在任何公开场合谈论的内容，例如您公司的商业机密、您的个人信息以及政治见解等。

如您希望在文档中署名，请在文章开头自动生成的格式化内容中添加以下内容：

---
author: 
  name: 您的名字
---

项目部署

在编辑或新建完文件后，保存文件并使用 Git 提交你的更改。具体的 Git 命令如下：

npm run deploy

这会调用一个脚本，实现打包、切换分支、推送行为。你可以在 GitHub 上查看你的更改。如您有兴趣，可以在项目根目录的 deploy.sh 中查看脚本的具体内容。

无编程基础者

如果这听起来有些困难不妨直接将创作的内容作为附件发送到我们的邮箱（注意需要是Markdown格式）。我们将在确保内容的合法合规性之后整理进入文档库。