guide/document/

[giscus[bot]]

guide/document/

概述 在本主题满足了 Blog的基本功能后，期望能够 以 note 或者 book 的形式聚合文章，形式上类似于 vuepress 默认主题。 同时也减少配置的复杂度。 它能够让你以更加友好的方式，组织管理你的文档，或者 知识笔记。 目录 文档/知识笔记 默认存放在 {sourceDir}/notes 目录下。 示例： 其中，typescript 和 ...

https://theme-plume.vuejs.press/guide/document/

[Mars13333]

按照当前页配置notes，没有生成文档/知识笔记。请问有什么需要注意的地方么？

[ChGoh7]

大大，貌似文件夹名称是中文的，notes无法生成侧边栏。
比如这样的：
const ProjectNote = defineNoteConfig({
text: '项目开发',
dir: '项目开发/', // 这项配置中文貌似没有生成侧边栏
link: 'notes/Project/',
sidebar: 'auto'
})
而
const ProjectNote = defineNoteConfig({
text: '项目开发',
dir: 'Project/', //配置了可以生成侧边栏
link: 'notes/Project/',
sidebar: 'auto'
})
不知道是否是一个bug

[pengzhanbo]

我在本地使用中文创建，包括多层嵌套，均能生成侧边栏，未能重现问题。你是否可以提供一个重现包给我进行检查。
https://v2.vuepress.vuejs.org/new 可以使用这个进行在线编辑重现包。

[ChGoh7]

已复现，链接为https://stackblitz.com/edit/vuepress-q4qop5?file=docs%2F.vuepress%2Fplume.config.ts，
可能是我的使用方式有错误，作者考虑过出一个博客来讲解一下你的使用案例吗，对这个notes用的比较迷

[pengzhanbo]

中文编码问题。不是 dir 字段的问题，是 link 字段中包含了中文。我在处理 sidebar 时未考虑 链接中包含 中文 的情况，导致了在对 链接进行 解析时，未匹配到对应的 sidebar 数据。实际上是有生成的。

关于 notes，我一开始的想法就是将 sidebar 做更语义化的配置，同时映射到文件夹结构上，因为原本 vuepress 的默认主题的 sidebar 配置对新手来说并不友好，实际上 notes 应该是 https://pengzhanbo.cn/memorandum/ 类似这种，相当于一个 子文档，有可选的单独主页，以及一系列文章的聚合。

主题依然保留了 sidebar 配置项，满足不同的使用习惯。

[ChGoh7]

感谢作者答复，确实vuepress官网那个sidebar配的我很难受，还是作者的notes这个比较适合我

[tianhairui]

作者好，我在环境中按照该文档中的文件结构及侧标栏做了对应的配置，侧标栏配置为自动生成，config.js 中相关配置如下：

......
    notes: {
      link: '/',
      dir: '/notes/',
      notes: [
        {
          dir: 'typescript',
          link: '/typescript/',
          sidebar: 'auto'
        },
        {
          dir: 'ruby',
          link: '/ruby/',
          sidebar: [
            {text: '简介', items: ['intro.md']}
          ]
        }
      ], 
    }
......
// 之后，我在 navbar 导航栏中配置如下，起名叫 Book
{ text: 'Book', link: '/article/cyc1oseq/', icon: 'hugeicons:note-01'/*'material-symbols:article-outline'*/ }

这里我出现的问题是：
在navbar的link中，如果指定具体md文档中的的permalink，那么点击导航 Book 跳转至对应的文档，也没有侧边栏生成；如果指定具体的notes路径，点击导航 Book 就会出错，折腾了半个月，文档梳理了多遍，还是未能实现，请问我忽略了什么地方？

[sunshang-hl]

在开始配置前我以为很简单的,我按照教程操作的,但是侧边栏永远没办法正常显示,在项目demo示例下,我添加新的MD文件,按道理它会和foo一起正常显示对吧.但是并没有.能否建立一个用户交流群.让大家更加便捷的交流.

[sunshang-hl]

或者扩展模板项目,增加知识文档笔记侧边栏的相关配置,让用户开箱即用,尽可能完善所有的配置.用户只需要关注写作即可.非常的喜欢这款主题,因此还在继续尝试,解决我遇到的问题.

[sunshang-hl]

还有,目前访问这个网站,打开新页面,经常需要加载数十秒,是否对网站的性能进行优化呢?

[pengzhanbo]

@sunshang-hl 交流群已建立， discussions 公告有群号。
模板中的 docs/.vuepress/ 下就有 notes.ts 配置的 demo。
主题的文档站点是部署在 netlify 上的，服务器在海外，国内网络访问必然不会很快，一般使用下科学，访问速度还是可以的。

[sunshang-hl]

已申请入群,建议将群号放在文档首页或其他显眼的位置,便于用户入群交流. 是否可尝试将网站cdn部署在cloudflare,优化访问体验,而且没有费用支出.一点建议.