diff --git a/README.md b/README.md index 62f293f03..0589e590e 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ - [x] 基于 React，项目工程化，二次开发友好。 - [x] 内置强大的分析功能，可统计访客等数据。并配有精美看板。 - [x] 内嵌评论系统。 -- [x] 强大的 markdown 编辑器，支持图表和数学公式，一键插入 more 标记，一键剪切板及本地图片上传，支持自定义高亮块语法，支持 Emoji 表情选取。 +- [x] 强大的 Markdown 编辑器，支持图表和数学公式，一键插入 more 标记，一键剪切板及本地图片上传，支持自定义高亮块语法，支持 Emoji 表情选取。 - [x] TOC、草稿、代码复制、访客数、评论数、分类、标签、搜索、加密、友链、打赏、自定义导航栏。 - [x] 多个布局设置，可自定义页面细节。 - [x] 高度客制化，可添加自定义 CSS、HTML 和 JS 代码。 diff --git a/docs/feature/advance/rss.md b/docs/feature/advance/rss.md index 52eb9300d..1bab3c5c4 100644 --- a/docs/feature/advance/rss.md +++ b/docs/feature/advance/rss.md @@ -12,7 +12,7 @@ title: RSS > > `/atom.xml`。 -我特意实现了后端的 `markdown 渲染器`，所以你可以在 `RSS 阅读器` 上获得与网站本体尽可能相近的体验（在读取订阅源中 HTML 的情况下）。 +我特意实现了后端的 `Markdown 渲染器`，所以你可以在 `RSS 阅读器` 上获得与网站本体尽可能相近的体验（在读取订阅源中 HTML 的情况下）。 PS：但我没找到不增加额外组件优雅的实现后端渲染 `mermaid` 图表的方法，所以 `RSS 订阅中的 HTML` 没法展示 `mermaid 图表` 了。 diff --git a/docs/feature/basic/article.md b/docs/feature/basic/article.md index bbdf372dc..95eefb5fe 100644 --- a/docs/feature/basic/article.md +++ b/docs/feature/basic/article.md @@ -11,8 +11,6 @@ shortTitle: 文章管理 ![](https://pic.mereith.com/img/acc7dd7093ac0110cdffdb5d11e226df.clipboard-2022-08-15.png) - - ## 创建新文章 你可以点击 `新建文章` 按钮创建新文章，但一般情况下我建议你先创建一个`草稿`，然后再发布这个草稿。**因为由于内置的增量渲染新建的文章会马上展示在前台页面** @@ -21,7 +19,6 @@ shortTitle: 文章管理 ![](https://pic.mereith.com/img/c10e25ee028e3a7cd5306940ca146e80.clipboard-2023-02-27.png) - 点击确定后，则以该表单为数据进行文章创建。 ### 文章标题 @@ -38,7 +35,6 @@ shortTitle: 文章管理 比如，自定义的路径名设置成 `如何部署vanblog`，发布后可以通过 `/post/如何部署vanblog` 来访问。 - ### 顶置优先级 必须为数字，留空或者为 0 表示不顶置，否则会把数字大的拍到最前面。（默认的话是时间倒序的，新建的文章放到最前面。 @@ -65,13 +61,13 @@ shortTitle: 文章管理 选择隐藏后，前台将不会该显示文章的所有信息，该文章也不会计入总字数、标签、分类数量统计或者出现在时间线界面。但后台将正常显示该文章，并可以取消隐藏状态。 -## 导入 markdown +## 导入 Markdown -你可以点击 `导入` 按钮导入 `markdown` 文件来创建文章，暂不支持其他类型的文件。 +你可以点击 `导入` 按钮导入 `Markdown` 文件来创建文章，暂不支持其他类型的文件。 ![](https://pic.mereith.com/img/537490f086ff26ab0b339bd68f7f9016.clipboard-2022-08-29.png) -其中，`markdown` 文件的 [front-matter](https://hexo.bootcss.com/docs/front-matter.html) 将会被自动解析成 `vanblog` 的字段并展示在 弹出的确认表单中，具体而言： +其中，`Markdown` 文件的 [front-matter](https://hexo.bootcss.com/docs/front-matter.html) 将会被自动解析成 `vanblog` 的字段并展示在 弹出的确认表单中，具体而言： | 字段名称 | 映射到 vanblog 中的字段 | 说明 | | ---------- | ----------------------- | --------------------------------------------------------------- | @@ -89,7 +85,6 @@ shortTitle: 文章管理 ![](https://pic.mereith.com/img/1f0d74ef0ac87dd8f4b6e3e65b84bf84.clipboard-2022-08-29.png) - ## 编辑文章 在文章页面的表格点击编辑按钮，即可跳转到编辑器编辑文章。 @@ -116,7 +111,7 @@ shortTitle: 文章管理 你可以在文章管理页面操作栏下拉菜单中点击`导出`来导出文章，或者通过在编辑器中的导出按钮来导出文章。 -导出时会自动映射信息到 `markdown 文件` 的 `front-matter` 中。 +导出时会自动映射信息到 `Markdown 文件` 的 `front-matter` 中。 ## 删除文章 diff --git a/docs/feature/basic/draft.md b/docs/feature/basic/draft.md index aa7b4947c..ce85952be 100644 --- a/docs/feature/basic/draft.md +++ b/docs/feature/basic/draft.md @@ -24,13 +24,13 @@ title: 草稿管理 默认为登录者本人，下拉框内的选择范围包括`所有的协作者的昵称`以及后台站点设置中的`作者名称`。 -## 导入 markdown +## 导入 Markdown -你可以点击 `导入` 按钮导入 `markdown` 文件来创建草稿，暂不支持其他类型的文件。 +你可以点击 `导入` 按钮导入 `Markdown` 文件来创建草稿，暂不支持其他类型的文件。 ![](https://pic.mereith.com/img/513d3fa66a42e3832682d623a0f0f664.clipboard-2022-08-29.png) -其中，`markdown` 文件的 [front-matter](https://hexo.bootcss.com/docs/front-matter.html) 将会被自动解析成 `vanblog` 的字段并展示在 弹出的确认表单中，具体而言： +其中，`Markdown` 文件的 [front-matter](https://hexo.bootcss.com/docs/front-matter.html) 将会被自动解析成 `vanblog` 的字段并展示在 弹出的确认表单中，具体而言： | 字段名称 | 映射到 vanblog 中的字段 | 说明 | | ---------- | ----------------------- | --------------------------------------------------------------- | @@ -94,7 +94,7 @@ title: 草稿管理 你可以在草稿管理页面操作栏下拉菜单中点击`导出`来导出草稿，或者通过在编辑器中的导出按钮来导出草稿。 -导出时会自动映射信息到 `markdown 文件` 的 `front-matter` 中。 +导出时会自动映射信息到 `Markdown 文件` 的 `front-matter` 中。 ## 自动保存 diff --git a/docs/feature/basic/editor.md b/docs/feature/basic/editor.md index e178421ff..22c6352ad 100644 --- a/docs/feature/basic/editor.md +++ b/docs/feature/basic/editor.md @@ -3,11 +3,11 @@ title: 编辑器 --- ::: info 公告 -自 `v0.22.1` 起，`VanBlog` 切换为 [bytemd](https://github.com/bytedance/bytemd)（掘金同款编） 作为 markdown 编辑器。因为老的编辑器有些臃肿，还有些小毛病。 +自 `v0.22.1` 起，`VanBlog` 切换为 [bytemd](https://github.com/bytedance/bytemd)（掘金同款编） 作为 Markdown 编辑器。因为老的编辑器有些臃肿，还有些小毛病。 虽然新的编辑器不支持即时预览模式，但比较稳定简洁，易于拓展。 ::: -`vanBlog` 后台内置了 [bytemd](https://github.com/bytedance/bytemd)（掘金同款） 作为 `markdown` 编辑器： +`vanBlog` 后台内置了 [bytemd](https://github.com/bytedance/bytemd)（掘金同款） 作为 `Markdown` 编辑器： ![](https://www.mereith.com/static/img/e0ce4ddda865c9b7827983a219468599.clipboard-2022-09-06.png) @@ -57,13 +57,13 @@ title: 编辑器 ## 导入内容 -点击右上角操作按钮，选择 `导入内容`，选中需要导入的 `markdown` 文件即可。 +点击右上角操作按钮，选择 `导入内容`，选中需要导入的 `Markdown` 文件即可。 ![](https://pic.mereith.com/img/4218768fe6d1c8d69433bde3fd98c01b.clipboard-2022-08-30.png) ## 导出 -点击右上角操作按钮，选择 `导出`，即可导出为 `markdown` 文件，相关数据会自动放置到 `front-matter` 中。 +点击右上角操作按钮，选择 `导出`，即可导出为 `Markdown` 文件，相关数据会自动放置到 `front-matter` 中。 ![](https://www.mereith.com/static/img/52495adf0928d2034159a398cbc7e050.clipboard-2022-09-06.png) @@ -75,7 +75,7 @@ title: 编辑器 ## 语法速查、快捷键与帮助 -点击编辑器帮助按钮会显示 markdown 语法与快捷键信息： +点击编辑器帮助按钮会显示 Markdown 语法与快捷键信息： ![](https://pic.mereith.com/img/cabe5cdfddeedbd6e592f7aaea2f4afc.clipboard-2022-08-29.png) diff --git a/docs/feature/basic/pic.md b/docs/feature/basic/pic.md index c3a4aacac..e6fa4328c 100644 --- a/docs/feature/basic/pic.md +++ b/docs/feature/basic/pic.md @@ -82,7 +82,7 @@ title: 图床 其中对着图片点右键可以显示高级菜单，包括不限于`显示图片详细信息`和`查找被引用文章`等。 -上传图片后会自动复制图片`markdown 链接`到剪切板，需要复制 `url 链接` 的，可以对着图片点右键选择 `复制链接` +上传图片后会自动复制图片`Markdown 链接`到剪切板，需要复制 `url 链接` 的，可以对着图片点右键选择 `复制链接` ## 编辑器快捷上传