Handbook/docs/.vuepress/dist/assets/js/41.fd1151f7.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{366:function(t,s,a){"use strict";a.r(s);var n=a(4),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"如何参与编辑"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#如何参与编辑"}},[t._v("#")]),t._v(" 如何参与编辑")]),t._v(" "),s("p",[t._v("我们希望能有更多人参与到此份文档的编辑工作中，您可以通过以下几种方式参与文档的贡献。")]),t._v(" "),s("h2",{attrs:{id:"一、非开发者模式"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#一、非开发者模式"}},[t._v("#")]),t._v(" 一、非开发者模式")]),t._v(" "),s("ol",[s("li",[s("p",[t._v("您可以通过 "),s("strong",[t._v("发送邮件")]),t._v(" 的方式，将您的文档内容，放置于附件中，发送至 contact@hamcq.cn ，我们会回复此封邮件并告知接下来的工作及流程。")])]),t._v(" "),s("li",[s("p",[t._v("您可以通过 "),s("strong",[t._v("发表文章")]),t._v(" 的方式，访问 "),s("a",{attrs:{href:"https://forum.hamcq.cn",target:"_blank",rel:"noopener noreferrer"}},[t._v("forum.hamcq.cn"),s("OutboundLink")],1),t._v("，完成账号注册，在 "),s("code",[t._v("Wiki")]),t._v("  节点，发表您的内容，请在文章或标题中体现您的文档合并意向，会有管理员与您进行对接。")])])]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("提示")]),t._v(" "),s("p",[t._v("以下内容为开发者模式参考，如果您通过非开发者模式提交内容，请忽略以下内容，我们会帮您完成排版。")])]),t._v(" "),s("h2",{attrs:{id:"二、开发者模式"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#二、开发者模式"}},[t._v("#")]),t._v(" 二、开发者模式")]),t._v(" "),s("ol",[s("li",[s("p",[t._v("您可以通过 "),s("strong",[t._v("发起")]),t._v(" "),s("strong",[t._v("Issue")]),t._v(" 的方式，将您的文档内容，粘贴至 "),s("a",{attrs:{href:"https://github.com/HamCQ/Handbook/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("github.com/HamCQ/Handbook/issues"),s("OutboundLink")],1),t._v("。")])]),t._v(" "),s("li",[s("p",[t._v("您可以通过 "),s("strong",[t._v("Merge Request")]),t._v(" 的方式，直接将您的变更内容，请求合并至主分支。")])])]),t._v(" "),s("p",[t._v("本份文档使用  "),s("code",[t._v("VuePress1.x")]),t._v("  配合  "),s("code",[t._v("Vdoing")]),t._v("  生成。")]),t._v(" "),s("p",[t._v("参考材料：")]),t._v(" "),s("p",[t._v("VuePress: "),s("a",{attrs:{href:"https://vuepress.vuejs.org/zh/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://vuepress.vuejs.org/zh/"),s("OutboundLink")],1),s("br"),t._v("\nVdoing: "),s("a",{attrs:{href:"https://doc.xugaoyi.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://doc.xugaoyi.com/"),s("OutboundLink")],1)]),t._v(" "),s("h2",{attrs:{id:"如何在本地运行此文档"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#如何在本地运行此文档"}},[t._v("#")]),t._v(" 如何在本地运行此文档")]),t._v(" "),s("p",[t._v("请依次运行以下命令")]),t._v(" "),s("div",{staticClass:"language-sh extra-class"},[s("pre",{pre:!0,attrs:{class:"language-sh"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("git")]),t._v(" clone https://github.com/HamCQ/Handbook.git  \n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("cd")]),t._v(" Handbook  \n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v("  \n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("yarn")]),t._v(" docs:dev\n")])])]),s("h2",{attrs:{id:"内容规则"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#内容规则"}},[t._v("#")]),t._v(" 内容规则")]),t._v(" "),s("p",[t._v("在每一篇文章的顶部，可以放置您的署名信息。")]),t._v(" "),s("h4",{attrs:{id:"图片规则"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#图片规则"}},[t._v("#")]),t._v(" 图片规则")]),t._v(" "),s("p",[t._v("手册图片请放置于项目  "),s("code",[t._v("docs/.vuepress/public/img")]),t._v("  中，请勿使用图床地址，避免图片断链丢失。")]),t._v(" "),s("p",[s("strong",[t._v("图片归类")]),t._v("：")]),t._v(" "),s("p",[t._v("图片请按照对应章节进行归类：例如， "),s("code",[t._v("什么是业余无线电")]),t._v(" 章节中的 "),s("code",[t._v("一些故事")]),t._v(" ，归属  "),s("code",[t._v("0101")]),t._v("  归类，所属图片放置于  "),s("code",[t._v("/img/0101")]),t._v("  中。")]),t._v(" "),s("p",[s("strong",[t._v("图片命名规则")]),t._v("：")]),t._v(" "),s("p",[t._v("为了避免提交时与其他人产生文件冲突，个人标识仅允许 HamCQ 账号 ID 或电台呼号作为开头，例如： "),s("code",[t._v("hamcqID_01.png")]),t._v("  或  "),s("code",[t._v("BG5UWQ_01.png")]),t._v(" 。")]),t._v(" "),s("h4",{attrs:{id:"文章规则"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#文章规则"}},[t._v("#")]),t._v(" 文章规则")]),t._v(" "),s("p",[s("strong",[t._v("工程目录")])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v(".\n├── docs (请勿改动)\n│   ├── .vuepress （同官方，查看：https://vuepress.vuejs.org/zh/guide/directory-structure.html#目录结构）\n│   ├── @pages (请勿改动，自动生成的文件夹，存放分类页、标签页、归档页)\n│   ├── HamCQ手册（文档内容所在目录）\n│   └── index.md (首页)\n│\n└── package.json\n")])])]),s("p",[s("strong",[t._v("命名约定")])]),t._v(" "),s("ul",[s("li",[t._v("无论是文件还是文件夹，请为其名称添加上正确的正整数序号和.，从 00 或 01 开始累计，如 01. 文件夹、02. 文件.md，我们将会按照序号的顺序来决定其在侧边栏当中的顺序。")])]),t._v(" "),s("p",[s("strong",[t._v("目录结构案例")])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v(".\n├── docs\n│   │  (不参与数据生成)\n│   ├── .vuepress\n│   ├── @pages\n│   ├── index.md\n│   │\n│   │ (以下部分参与数据生成)\n│   ├── 《JavaScript教程》专栏 (一级目录)\n│   │   ├── 01.章节1 (二级目录)\n│   │   |   ├── 01.js1.md (三级目录-文件)\n│   │   |   ├── 02.js2.md\n│   │   |   └── 03.js3.md\n│   │   └── 02.章节2 (二级目录)\n│   │   |   ├── 01.jsa.md\n│   │   |   ├── 02.小节 (三级目录)\n│   │   |   |   └── 01.jsxx.md (四级目录-文件)\n│   ├── 01.前端\n│   │   ├── 01.JavaScript\n│   │   |   ├── 01.js1.md\n│   │   |   ├── 02.js2.md\n│   │   |   └── 03.js3.md\n│   │   └── 02.vue\n│   │   |   ├── 01.vue1.md\n│   │   |   └── 02.vue2.md\n│   ├── 02.其他\n│   │   ├── 01.学习\n│   │   |   ├── 01.xxa.md\n│   │   |   └── 02.xxb.md\n│   │   ├── 02.学习笔记\n│   │   |   ├── 01.xxa.md\n│   │   |   └── 02.xxb.md\n│   │   ├── 03.文件x.md\n│   │   └── 04.文件xx.md\n│   └── 03.关于我\n│   │   └── 01.关于我.md\n.   .\n")])])]),s("h1",{attrs:{id:"markdown-容器"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#markdown-容器"}},[t._v("#")]),t._v(" MarkDown 容器")]),t._v(" "),s("h2",{attrs:{id:"信息框容器"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#信息框容器"}},[t._v("#")]),t._v(" 信息框容器")]),t._v(" "),s("p",[t._v("输入")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('::: tip\n这是一条提示\n:::\n\n::: warning\n这是一条注意\n:::\n\n::: danger\n这是一条警告\n:::\n\n::: note\n这是笔记容器，在 <Badge text="v1.5.0 +" /> 版本才支持哦~\n:::\n\n::: tip 我的提示\n自定义标题的提示框\n:::\n')])])]),s("p",[t._v("输出")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("提示")]),t._v(" "),s("p",[t._v("这是一条提示")])]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("注意")]),t._v(" "),s("p",[t._v("这是一条注意")])]),t._v(" "),s("div",{staticClass:"custom-block danger"},[s("p",{staticClass:"custom-block-title"},[t._v("警告")]),t._v(" "),s("p",[t._v("这是一条警告")])]),t._v(" "),s("div",{staticClass:"custom-block note"},[s("p",{staticClass:"custom-block-title"},[t._v("笔记")]),t._v(" "),s("p",[t._v("这是笔记容器，在 "),s("Badge",{attrs:{text:"v1.5.0 +"}}),t._v(" 版本才支持哦～")],1)]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("我的提示")]),t._v(" "),s("p",[t._v("自定义标题的提示框")])]),t._v(" "),s("h2",{attrs:{id:"布局容器"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#布局容器"}},[t._v("#")]),t._v(" 布局容器")]),t._v(" "),s("p",[t._v("输入")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("::: center\n  ### 我是居中的内容\n  （可用于标题、图片等的居中）\n:::\n\n::: right\n  [我是右浮动的内容](https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B)\n:::\n\n::: details\n这是一个详情块，在 IE / Edge 中不生效\njs\nconsole.log('这是一个详情块')\n\n:::\n\n::: theorem 牛顿第一定律\n假若施加于某物体的外力为零，则该物体的运动速度不变。\n::: right\n来自 [维基百科](https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B)\n:::\n")])])]),s("p",[t._v("输出")]),t._v(" "),s("div",{staticClass:"center-container"},[s("h3",{attrs:{id:"我是居中的内容"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#我是居中的内容"}},[t._v("#")]),t._v(" 我是居中的内容")]),t._v(" "),s("p",[t._v("（可用于标题、图片等的居中）")])]),s("div",{staticClass:"custom-block right"},[s("p",[s("a",{attrs:{href:"https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B",target:"_blank",rel:"noopener noreferrer"}},[t._v("我是右浮动的内容"),s("OutboundLink")],1)])]),t._v(" "),s("details",{staticClass:"custom-block details"},[s("summary",[t._v("点击查看")]),t._v(" "),s("p",[t._v("这是一个详情块，在 IE / Edge 中不生效")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'这是一个详情块'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])])]),t._v(" "),s("div",{staticClass:"custom-block theorem"},[s("p",{staticClass:"title"},[t._v("牛顿第一定律")]),s("p",[t._v("假若施加于某物体的外力为零，则该物体的运动速度不变。")]),t._v(" "),s("div",{staticClass:"custom-block right"},[s("p",[t._v("来自 "),s("a",{attrs:{href:"https://zh.wikipedia.org/wiki/%E7%89%9B%E9%A1%BF%E8%BF%90%E5%8A%A8%E5%AE%9A%E5%BE%8B",target:"_blank",rel:"noopener noreferrer"}},[t._v("维基百科"),s("OutboundLink")],1)])])]),s("p",[t._v("更多写法可以参考 Vuepress 或 Vdoing 文档。")])])}),[],!1,null,null,null);s.default=e.exports}}]);