永固笔记#
自 2024-08 下旬,新增的笔记平坦放置在 /p
下,p 意即永固(Permanent) [1],笔记一旦加入,除非删除,其 URL 不再改变。
- Pros
URL 固定不变,SEO 友好
归类负担降低:
归类后期可变,且变更不影响可访问性
允许暂时不归类,一些内容可以提前发布
允许一个文档有多个分类
悲报:文档 实际上不允许被多个 toctree 包含
- Cons
docname/URL 级别丧失目录结构,可读性变差
📦 sphinxnotes-snippet 目前根据 docname 匹配 snippet 类型
和原笔记稍显割裂
迁移#
新增的,未能良好归类的笔记平坦放置在
/p
下归类良好的怎么办 存疑
原有的笔记大部分不迁移;归类不佳的、不希望展示的笔记,通过 迁移脚本 迁移到
/p
下原有的
toctree
保留,但通过指定 docname 的方式继续更新(而非原来的:glob:
) 存疑待补充
目前的迁移脚本:
#!/bin/bash
# set -x
root=$(git rev-parse --show-toplevel)
cd $root
eval "$(snippet integration --sh)"
id=$(snippet_list --tags d)
file=$(snippet get $id --file)
docname=$(snippet get $id --docname)
new_file="$root/p/$(basename $file)"
new_docname="p/$(basename $docname)"
mv $file $new_file
if [[ "$docname" != "ronin"* ]]; then
echo "$docname: /$new_docname.html" >> ./_conf/redirect.yml
sed -i "1i:isso-id: /$docname\n" $new_file
git add $file $new_file ./_conf/redirect.yml
else
git add $new_file
fi
git diff HEAD
评论
如果你有任何意见,请在此评论。 如果你留下了电子邮箱,我可能会通过 回复你。