HamCQ手册
2023-10-20
目录

如何参与编辑

# 如何参与编辑

我们希望能有更多人参与到此份文档的编辑工作中，您可以通过以下几种方式参与文档的贡献。

# 一、非开发者模式

  1. 您可以通过 发送邮件 的方式，将您的文档内容，放置于附件中，发送至 contact@hamcq.cn ，我们会回复此封邮件并告知接下来的工作及流程。

  2. 您可以通过 发表文章 的方式，访问 forum.hamcq.cn (opens new window)，完成账号注册，在Wiki节点，发表您的内容，请在文章或标题中体现您的文档合并意向，会有管理员与您进行对接。

提示

以下内容为开发者模式参考，如果您通过非开发者模式提交内容，请忽略以下内容，我们会帮您完成排版。

# 二、开发者模式

  1. 您可以通过 发起 Issue 的方式，将您的文档内容，粘贴至 github.com/HamCQ/Handbook/issues (opens new window)。

  2. 您可以通过 Merge Request 的方式，直接将您的变更内容，请求合并至主分支。

本份文档使用 VuePress1.x 配合 Vdoing 生成。

参考材料：

VuePress: https://vuepress.vuejs.org/zh/ (opens new window)
Vdoing: https://doc.xugaoyi.com/ (opens new window)

# 如何在本地运行此文档

请依次运行以下命令

git clone https://github.com/HamCQ/Handbook.git  
cd Handbook  
yarn install  
yarn docs:dev

# 内容规则

在每一篇文章的顶部，可以放置您的署名信息。

# 图片规则

手册图片请放置于项目 docs/.vuepress/public/img 中，请勿使用图床地址，避免图片断链丢失。

图片归类：

图片请按照对应章节进行归类：例如，什么是业余无线电章节中的一些故事，归属 0101 归类，所属图片放置于 /img/0101 中。

图片命名规则：

为了避免提交时与其他人产生文件冲突，个人标识仅允许 HamCQ 账号 ID 或电台呼号作为开头，例如：hamcqID_01.png 或 BG5UWQ_01.png。

# 文章规则

工程目录

.
├── docs (请勿改动)
│   ├── .vuepress （同官方，查看：https://vuepress.vuejs.org/zh/guide/directory-structure.html#目录结构）
│   ├── @pages (请勿改动，自动生成的文件夹，存放分类页、标签页、归档页)
│   ├── HamCQ手册（文档内容所在目录）
│   └── index.md (首页)
│
└── package.json

命名约定

  • 无论是文件还是文件夹，请为其名称添加上正确的正整数序号和.，从00或01开始累计，如01.文件夹、02.文件.md，我们将会按照序号的顺序来决定其在侧边栏当中的顺序。

目录结构案例

.
├── docs
│   │  (不参与数据生成)
│   ├── .vuepress
│   ├── @pages
│   ├── index.md
│   │
│   │ (以下部分参与数据生成)
│   ├── 《JavaScript教程》专栏 (一级目录)
│   │   ├── 01.章节1 (二级目录)
│   │   |   ├── 01.js1.md (三级目录-文件)
│   │   |   ├── 02.js2.md
│   │   |   └── 03.js3.md
│   │   └── 02.章节2 (二级目录)
│   │   |   ├── 01.jsa.md
│   │   |   ├── 02.小节 (三级目录)
│   │   |   |   └── 01.jsxx.md (四级目录-文件)
│   ├── 01.前端
│   │   ├── 01.JavaScript
│   │   |   ├── 01.js1.md
│   │   |   ├── 02.js2.md
│   │   |   └── 03.js3.md
│   │   └── 02.vue
│   │   |   ├── 01.vue1.md
│   │   |   └── 02.vue2.md
│   ├── 02.其他
│   │   ├── 01.学习
│   │   |   ├── 01.xxa.md
│   │   |   └── 02.xxb.md
│   │   ├── 02.学习笔记
│   │   |   ├── 01.xxa.md
│   │   |   └── 02.xxb.md
│   │   ├── 03.文件x.md
│   │   └── 04.文件xx.md
│   └── 03.关于我
│   │   └── 01.关于我.md
.   .

# MarkDown 容器

# 信息框容器

输入

::: tip
这是一条提示
:::

::: warning
这是一条注意
:::

::: danger
这是一条警告
:::

::: note
这是笔记容器，在 <Badge text="v1.5.0 +" /> 版本才支持哦~
:::

::: tip 我的提示
自定义标题的提示框
:::

输出

提示

这是一条提示

注意

这是一条注意

警告

这是一条警告

笔记

这是笔记容器，在 v1.5.0 + 版本才支持哦~

我的提示

自定义标题的提示框

# 布局容器

输入

::: center
  ### 我是居中的内容
  （可用于标题、图片等的居中）
:::

::: right
  [我是右浮动的内容](https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B)
:::

::: details
这是一个详情块，在 IE / Edge 中不生效
js
console.log('这是一个详情块')

:::

::: theorem 牛顿第一定律
假若施加于某物体的外力为零，则该物体的运动速度不变。
::: right
来自 [维基百科](https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B)
:::

输出

# 我是居中的内容

（可用于标题、图片等的居中）

我是右浮动的内容 (opens new window)

点击查看

这是一个详情块，在 IE / Edge 中不生效

console.log('这是一个详情块')

牛顿第一定律

假若施加于某物体的外力为零，则该物体的运动速度不变。

来自 维基百科 (opens new window)

更多写法可以参考 Vuepress 或 Vdoing 文档。

Theme by Vdoing