diff --git a/vx_notebook/notebook.db b/vx_notebook/notebook.db index d6e0c6e4..da411d58 100644 Binary files a/vx_notebook/notebook.db and b/vx_notebook/notebook.db differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx.json b/zh_cn/docs/开发者/01 - 开发入门/vx.json new file mode 100644 index 00000000..365bfa87 --- /dev/null +++ b/zh_cn/docs/开发者/01 - 开发入门/vx.json @@ -0,0 +1,21 @@ +{ + "created_time": "2022-01-12T16:29:45Z", + "files": [ + { + "attachment_folder": "", + "created_time": "2022-01-12T16:31:52Z", + "id": "53", + "modified_time": "2022-01-13T02:09:43Z", + "name": "如何给VNote开发文档.md", + "signature": "5546498803233653368", + "tags": [ + ] + } + ], + "folders": [ + ], + "id": "54", + "modified_time": "2022-01-12T16:29:45Z", + "signature": "207324008350201", + "version": 3 +} diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/130024803648320.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/130024803648320.png new file mode 100644 index 00000000..6ae25169 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/130024803648320.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/151165171356026.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/151165171356026.png new file mode 100644 index 00000000..07f8eca2 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/151165171356026.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/187424406122274.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/187424406122274.png new file mode 100644 index 00000000..77b7cdfe Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/187424406122274.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/473335114940750.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/473335114940750.png new file mode 100644 index 00000000..7d288405 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/473335114940750.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/497484154936618.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/497484154936618.png new file mode 100644 index 00000000..47b409e2 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/497484154936618.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/532224850548860.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/532224850548860.png new file mode 100644 index 00000000..71b95139 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/532224850548860.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/548035278889154.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/548035278889154.png new file mode 100644 index 00000000..f3c721b9 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/548035278889154.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/551853692522484.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/551853692522484.png new file mode 100644 index 00000000..9d92f7a8 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/551853692522484.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/56773707575796.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/56773707575796.png new file mode 100644 index 00000000..d9aa226c Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/56773707575796.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/584175538751262.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/584175538751262.png new file mode 100644 index 00000000..497984aa Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/584175538751262.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/588443864806804.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/588443864806804.png new file mode 100644 index 00000000..9a81070f Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/588443864806804.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/66085199114452.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/66085199114452.png new file mode 100644 index 00000000..271dc0aa Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/66085199114452.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/vx_images/7295096900944.png b/zh_cn/docs/开发者/01 - 开发入门/vx_images/7295096900944.png new file mode 100644 index 00000000..c83b16a3 Binary files /dev/null and b/zh_cn/docs/开发者/01 - 开发入门/vx_images/7295096900944.png differ diff --git a/zh_cn/docs/开发者/01 - 开发入门/如何给VNote开发文档.md b/zh_cn/docs/开发者/01 - 开发入门/如何给VNote开发文档.md new file mode 100644 index 00000000..6a21ade4 --- /dev/null +++ b/zh_cn/docs/开发者/01 - 开发入门/如何给VNote开发文档.md @@ -0,0 +1,90 @@ +# 如何给VNote开发文档 + +## 获取文档 + +首先在 https://github.com/vnotex/vnote Fork 项目。 + +![](vx_images/473335114940750.png) + +然后在自己的页面里,获得 Clone 地址。 + +![](vx_images/548035278889154.png) + +因为 `文档` 与 `源码` 是两个分支。这里在 Clone 的时候建议,起一个别名。 + +比如 `git@github.com:${YOU_NAME}/vnote.git vnote-document` + +然后添加 Remote `git remote add vnotex git@github.com:vnotex/vnote.git` + +添加完后效果如下 + +![](vx_images/56773707575796.png) + +此时我们切换到文档的专用 `分支`。 + +`git checkout origin/gh-pages` + +然后再起一个本地的别名,我一般就与原始同名 + +`git checkout -b gh-pages` + +最后再获取一下远端仓库的更新,并合并到当前分支中 + +`git fetch vnotex && git pull vnotex gh-pages` + +![](vx_images/187424406122274.png) + +此时你就获得了最新的 `文档` 了。并且该文档是可以使用 `VNote` 开发! + +## 开发文档 + +我们打开 `VNote`,然后选择 `打开其他笔记本`。 + +![](vx_images/497484154936618.png) + +定位到我们刚才获取最新的文档目录。 + +![](vx_images/588443864806804.png) + + +打开后,默认会显示所有文件,这里我们为了方便 `文档` 开发,把 `显示外部文件` 的勾去掉。 + +![](vx_images/7295096900944.png) + + +然后我们就可以创建文档啦,比如我现在这篇,`如何给 VNote 开发文档`! + +![](vx_images/551853692522484.png) + + +## 提交文档 + +开发完成后,当然是要进行提交呀。 + +**注意!我们现在是在文档主分支下开发的,按照 Git 开发约定,我们需要 checkout 一个新分支出来,然提 PR** + +![](vx_images/130024803648320.png) + +切换到新分支后,我们将进行 `add、commit、push` 一条龙操作。 + +![](vx_images/532224850548860.png) + +![](vx_images/151165171356026.png) + +注意,此时是提交到了自己的 Github 中,需要到页面上去发起 PR 合并申请。 + +![](vx_images/584175538751262.png) + +发起 PR 合并申请的时候,**千万! 千万! 注意选对分支** + +::: alert-danger +分支请选择gh-pages +分支请选择gh-pages +分支请选择gh-pages +::: + +标题和内容,不做强要求,但是最好用简单好理解的英文表示。 + +![](vx_images/66085199114452.png) + +最后,我们点击 `Create pull request`,发起你的第一个 `PR` 吧! \ No newline at end of file diff --git a/zh_cn/docs/开发者/vx.json b/zh_cn/docs/开发者/vx.json index e9631e34..39a2ea41 100644 --- a/zh_cn/docs/开发者/vx.json +++ b/zh_cn/docs/开发者/vx.json @@ -13,6 +13,9 @@ } ], "folders": [ + { + "name": "01 - 开发入门" + } ], "id": "43", "modified_time": "2021-05-12T12:13:25Z",