Browse Source

add docs for export

Le Tan 4 years ago
parent
commit
ebc87673f7
41 changed files with 125 additions and 65 deletions
  1. BIN
      en_us/_v_images/20181124163939673_81017666.png
  2. BIN
      en_us/_v_images/20181124164023649_131131901.png
  3. BIN
      en_us/_v_images/20181124164046638_337092662.png
  4. BIN
      en_us/_v_images/20181124164058289_1232467902.png
  5. BIN
      en_us/_v_images/20181124164129480_2136699189.png
  6. BIN
      en_us/_v_images/20181124164142595_204757426.png
  7. BIN
      en_us/_v_images/20181124164149249_1895919077.png
  8. BIN
      en_us/_v_images/20181124164227082_1627336110.png
  9. 35 0
      en_us/docs/Users/Export.md
  10. 9 0
      en_us/docs/Users/vx.json
  11. BIN
      en_us/docs/Users/vx_images/4367026137329.png
  12. BIN
      en_us/docs/Users/vx_images/5544934122307.png
  13. BIN
      en_us/docs/Users/vx_images/5956529129998.png
  14. BIN
      en_us/docs/Users/vx_images/82232126553.png
  15. 1 1
      en_us/index.md
  16. 3 27
      en_us/screenshots.md
  17. 2 2
      en_us/vx.json
  18. BIN
      en_us/vx_images/4085821110870.png
  19. BIN
      en_us/vx_images/4948717110870.png
  20. BIN
      en_us/vx_images/90420129296.png
  21. 25 5
      vx_notebook/vx_notebook.json
  22. BIN
      zh_cn/_v_images/20181124163939673_81017666.png
  23. BIN
      zh_cn/_v_images/20181124164023649_131131901.png
  24. BIN
      zh_cn/_v_images/20181124164046638_337092662.png
  25. BIN
      zh_cn/_v_images/20181124164058289_1232467902.png
  26. BIN
      zh_cn/_v_images/20181124164129480_2136699189.png
  27. BIN
      zh_cn/_v_images/20181124164142595_204757426.png
  28. BIN
      zh_cn/_v_images/20181124164149249_1895919077.png
  29. BIN
      zh_cn/_v_images/20181124164227082_1627336110.png
  30. 9 0
      zh_cn/docs/用户/vx.json
  31. BIN
      zh_cn/docs/用户/vx_images/3433645116534.png
  32. BIN
      zh_cn/docs/用户/vx_images/383443137791.png
  33. BIN
      zh_cn/docs/用户/vx_images/4172140140187.png
  34. BIN
      zh_cn/docs/用户/vx_images/5641943135293.png
  35. 35 0
      zh_cn/docs/用户/导出.md
  36. 1 1
      zh_cn/index.md
  37. 3 27
      zh_cn/screenshots.md
  38. 2 2
      zh_cn/vx.json
  39. BIN
      zh_cn/vx_images/2608223110870.png
  40. BIN
      zh_cn/vx_images/3111523129296.png
  41. BIN
      zh_cn/vx_images/3749923117163.png

BIN
en_us/_v_images/20181124163939673_81017666.png


BIN
en_us/_v_images/20181124164023649_131131901.png


BIN
en_us/_v_images/20181124164046638_337092662.png


BIN
en_us/_v_images/20181124164058289_1232467902.png


BIN
en_us/_v_images/20181124164129480_2136699189.png


BIN
en_us/_v_images/20181124164142595_204757426.png


BIN
en_us/_v_images/20181124164149249_1895919077.png


BIN
en_us/_v_images/20181124164227082_1627336110.png


+ 35 - 0
en_us/docs/Users/Export.md

@@ -0,0 +1,35 @@
+# Export
+VNote supports exporting notes to multiple formats, such as `Markdown`, `PDF`, and `HTML`. With [Pandoc](https://pandoc.org/), more target formats are supported.
+
+## General Settings
+![](vx_images/4367026137329.png)
+
+* VNote allows exporting current note, notes in current folder, and notes in current notebook.
+* Target formats are `Markdown`, `HTML`, `PDF`, and `Custom`.
+* VNote allows specifying different rendering styles in export.
+
+## Markdown
+VNote will export the file into `Markdown` format within one single folder, with its images and attachments.
+
+## HTML
+![](vx_images/5956529129998.png)
+
+VNote allows to export file into one single `HTML` page, with its styles and images embedded, so it is easier to share it to others.
+
+## PDF
+![](vx_images/82232126553.png)
+
+VNote supports exporting to `PDF` directly or using `wkhtmltopdf` tool to export. With `wkhtmltopdf`, outline is supported.
+
+`All-In-One` option allows to export and combine multiple source files into one target file.
+
+## Custom
+![](vx_images/5544934122307.png)
+
+VNote allows to export files using customized command. It is common to use `pandoc` tool to convert to other formats. Please refer to the documentation of `pandoc` for details. You could even use a script to handle it in your own way.
+
+The following command on Windows could export to nearly every format via `pandoc`. Just change the `Target file suffix` into `docx`, `epub`, and so on.
+
+```
+pandoc.exe --resource-path=.;%2 --css=%3 --css=%4 -s -o %5 %1
+```

+ 9 - 0
en_us/docs/Users/vx.json

@@ -82,6 +82,15 @@
             "tags": [
             ]
         },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-29T03:24:23Z",
+            "id": "0",
+            "modified_time": "2021-08-29T03:44:20Z",
+            "name": "Export.md",
+            "tags": [
+            ]
+        },
         {
             "attachment_folder": "",
             "created_time": "2018-11-24T12:22:16Z",

BIN
en_us/docs/Users/vx_images/4367026137329.png


BIN
en_us/docs/Users/vx_images/5544934122307.png


BIN
en_us/docs/Users/vx_images/5956529129998.png


BIN
en_us/docs/Users/vx_images/82232126553.png


+ 1 - 1
en_us/index.md

@@ -3,7 +3,7 @@
 
 ::: alert-success
 
-VNote 3.6.0 is released! Check out [what's new](https://github.com/vnotex/vnote/releases)!
+VNote 3.7.0 is released! Check out [what's new](https://github.com/vnotex/vnote/releases)!
 
 :::
 

+ 3 - 27
en_us/screenshots.md

@@ -1,30 +1,6 @@
 # Screenshots
-![Light Theme](_v_images/20181124163939673_81017666.png)
+![Light Theme](vx_images/4948717110870.png)
 
-***
+![](vx_images/90420129296.png)
 
-![Dark Theme](_v_images/20181124164023649_131131901.png)
-
-***
-
-![In-Place Preview](_v_images/20181124164046638_337092662.png)
-
-***
-
-![Insert Image](_v_images/20181124164058289_1232467902.png)
-
-***
-
-![Syntax Highlight](_v_images/20181124164129480_2136699189.png)
-
-***
-
-![Full-Text Search](_v_images/20181124164142595_204757426.png)
-
-***
-
-![Export](_v_images/20181124164149249_1895919077.png)
-
-***
-
-![Fuzzy Search via Universal Entry](_v_images/20181124164227082_1627336110.png)
+![Dark Theme](vx_images/4085821110870.png)

+ 2 - 2
en_us/vx.json

@@ -5,7 +5,7 @@
             "attachment_folder": "",
             "created_time": "2018-11-24T05:04:27Z",
             "id": "0",
-            "modified_time": "2021-08-14T00:39:58Z",
+            "modified_time": "2021-08-29T03:16:36Z",
             "name": "index.md",
             "tags": [
             ]
@@ -23,7 +23,7 @@
             "attachment_folder": "",
             "created_time": "2018-11-24T07:21:10Z",
             "id": "0",
-            "modified_time": "2018-11-24T07:21:10Z",
+            "modified_time": "2021-08-29T03:21:42Z",
             "name": "screenshots.md",
             "tags": [
             ]

BIN
en_us/vx_images/4085821110870.png


BIN
en_us/vx_images/4948717110870.png


BIN
en_us/vx_images/90420129296.png


+ 25 - 5
vx_notebook/vx_notebook.json

@@ -11,11 +11,6 @@
             "line_number": -1,
             "path": "zh_cn/docs/用户/主题和样式.md"
         },
-        {
-            "last_accessed_time": "2021-08-14T00:39:48Z",
-            "line_number": 20,
-            "path": "zh_cn/index.md"
-        },
         {
             "last_accessed_time": "2021-08-14T00:39:58Z",
             "line_number": 0,
@@ -35,6 +30,31 @@
             "last_accessed_time": "2021-08-14T01:12:41Z",
             "line_number": -1,
             "path": "zh_cn/docs/用户/图床.md"
+        },
+        {
+            "last_accessed_time": "2021-08-29T03:23:59Z",
+            "line_number": 3,
+            "path": "zh_cn/screenshots.md"
+        },
+        {
+            "last_accessed_time": "2021-08-29T03:24:00Z",
+            "line_number": 1,
+            "path": "en_us/screenshots.md"
+        },
+        {
+            "last_accessed_time": "2021-08-29T03:24:10Z",
+            "line_number": -1,
+            "path": "zh_cn/index.md"
+        },
+        {
+            "last_accessed_time": "2021-08-29T03:48:11Z",
+            "line_number": 19,
+            "path": "zh_cn/docs/用户/导出.md"
+        },
+        {
+            "last_accessed_time": "2021-08-29T03:48:12Z",
+            "line_number": 26,
+            "path": "en_us/docs/Users/Export.md"
         }
     ],
     "image_folder": "vx_images",

BIN
zh_cn/_v_images/20181124163939673_81017666.png


BIN
zh_cn/_v_images/20181124164023649_131131901.png


BIN
zh_cn/_v_images/20181124164046638_337092662.png


BIN
zh_cn/_v_images/20181124164058289_1232467902.png


BIN
zh_cn/_v_images/20181124164129480_2136699189.png


BIN
zh_cn/_v_images/20181124164142595_204757426.png


BIN
zh_cn/_v_images/20181124164149249_1895919077.png


BIN
zh_cn/_v_images/20181124164227082_1627336110.png


+ 9 - 0
zh_cn/docs/用户/vx.json

@@ -82,6 +82,15 @@
             "tags": [
             ]
         },
+        {
+            "attachment_folder": "",
+            "created_time": "2021-08-29T03:38:55Z",
+            "id": "0",
+            "modified_time": "2021-08-29T03:48:03Z",
+            "name": "导出.md",
+            "tags": [
+            ]
+        },
         {
             "attachment_folder": "",
             "created_time": "2018-11-24T12:31:22Z",

BIN
zh_cn/docs/用户/vx_images/3433645116534.png


BIN
zh_cn/docs/用户/vx_images/383443137791.png


BIN
zh_cn/docs/用户/vx_images/4172140140187.png


BIN
zh_cn/docs/用户/vx_images/5641943135293.png


+ 35 - 0
zh_cn/docs/用户/导出.md

@@ -0,0 +1,35 @@
+# 导出
+VNote 支持将笔记导出为多种格式,如 `Markdown`, `PDF` 和 `HTML`。 通过使用 [Pandoc](https://pandoc.org/),可以支持更多目标格式。
+
+## 通用设置
+![](vx_images/4172140140187.png)
+
+* VNote 支持导出当前笔记、当前文件夹的笔记以及当前笔记本的所有笔记。
+* 目前格式包括 `Markdown`, `HTMl`, `PDF` 和 `自定义`。
+* VNote 支持指定导出时使用不同的渲染样式。
+
+## Markdown
+VNote 会将文件导出为 `Markdown` 格式到一个单独的目录,其中包含对应的图片和附件。
+
+## HTML
+![](vx_images/383443137791.png)
+
+VNote 允许将文件导出为一个单独的 `HTML` 页面,其中会嵌入用到的样式和图片,方便分享。
+
+## PDF
+![](vx_images/5641943135293.png)
+
+VNote 支持直接导出为 `PDF` 或者通过 `wkhtmltopdf` 工具进行导出。后者支持大纲。
+
+`多合一` 选项运行将多个文件导出并合并为一个目标文件。
+
+## 自定义
+![](vx_images/3433645116534.png)
+
+VNote 允许使用自定义的命令来导出文件。一个常用的工具是 `pandoc`。请参考该工具的文档以获取详细用法。我们甚至可以使用脚本来处理笔记。
+
+在 Windows 上,以下命令通过使用 `pandoc` 可以将文件导出为几乎任意格式。只需要修改 `目标文件后缀` 为 `docx` 或者 `epub` 等即可。
+
+```
+pandoc.exe --resource-path=.;%2 --css=%3 --css=%4 -s -o %5 %1
+```

+ 1 - 1
zh_cn/index.md

@@ -3,7 +3,7 @@
 
 ::: alert-success
 
-VNote 3.6.0 已发布! 看看都有[哪些更新](https://github.com/vnotex/vnote/releases) !
+VNote 3.7.0 已发布! 看看都有[哪些更新](https://github.com/vnotex/vnote/releases) !
 
 观看[展示录屏](https://www.bilibili.com/video/av77455284) !
 

+ 3 - 27
zh_cn/screenshots.md

@@ -1,30 +1,6 @@
 # 使用截图
-![浅色主题](_v_images/20181124163939673_81017666.png)
+![](vx_images/2608223110870.png)
 
-***
+![](vx_images/3111523129296.png)
 
-![深色主题](_v_images/20181124164023649_131131901.png)
-
-***
-
-![原地预览](_v_images/20181124164046638_337092662.png)
-
-***
-
-![插入图片](_v_images/20181124164058289_1232467902.png)
-
-***
-
-![语法高亮](_v_images/20181124164129480_2136699189.png)
-
-***
-
-![全文搜索](_v_images/20181124164142595_204757426.png)
-
-***
-
-![导出](_v_images/20181124164149249_1895919077.png)
-
-***
-
-![通用入口中的模糊查找](_v_images/20181124164227082_1627336110.png)
+![](vx_images/3749923117163.png)

+ 2 - 2
zh_cn/vx.json

@@ -5,7 +5,7 @@
             "attachment_folder": "",
             "created_time": "2018-11-24T09:30:11Z",
             "id": "0",
-            "modified_time": "2018-11-24T09:30:11Z",
+            "modified_time": "2021-08-29T03:23:39Z",
             "name": "screenshots.md",
             "tags": [
             ]
@@ -23,7 +23,7 @@
             "attachment_folder": "",
             "created_time": "2018-11-24T09:30:11Z",
             "id": "0",
-            "modified_time": "2021-08-14T00:39:46Z",
+            "modified_time": "2021-08-29T03:16:48Z",
             "name": "index.md",
             "tags": [
             ]

BIN
zh_cn/vx_images/2608223110870.png


BIN
zh_cn/vx_images/3111523129296.png


BIN
zh_cn/vx_images/3749923117163.png