文档系统调研

created: [ 2022-04-01 14:57 ]

aliases: [ 文档系统调研 ]

tags: [ vps ]

number headings: first-level 1, max 6, auto, contents toc

Modified:: <%+ tp.file.last_modified_date() %>

1 背景:

一直没分清楚 博客 文档系统 的差异, 看到这个说明.

另外, 文档系统 又叫做文档框架.

这个应该是从 谁渲染 的角度来判断的, 我更关注的是内容的摆放吧.

title: Quote

[WordPress和Typecho选哪个-美国VPS综合讨论-全球主机交流论坛 - Powered by Discuz!](https://hostloc.com/forum.php?mod=viewthread&tid=948987&highlight=Typecho)
不需要,简单解释下它们的区别:  
  
像 WordPress 和 Typecho 这种 PHP **动态博客程序**,会在用户每次访问时根据程序、主题、插件等**动态**生成一个**最终的静态页面**(除非配置了缓存插件将这些页面都保存下来,下次访问就直接返回缓存的静态网页了)。  
  
而 **静态系统**(或者叫**静态博客程序**)和它们的区别就是,**提前生成最终的静态页面**(可以自己生成后再去上传到服务器,也可以交给服务器自动生成),这样用户访问的时候,服务器就直接返回静态网页。  
  
而 **文档系统**,就是直接加载 .md 文件,然后浏览器用 JS/CSS 去渲染 markdown 语法,并根据主题、插件等(js/css)在网页上添加功能什么的,服务器只需要发送 index.html、.js、.css、.md 这些静态文件即可,剩下的都由浏览器去渲染、加载。  
  
因此 静态系统、文档系统 可以放在**纯静态** HTTP 服务下,如  Github Page、Cloudflare Page、Vercel 等,连服务器、域名都可以省去~  
  
注意:静态系统、文档系统 因为其不存在数据库,因此**评论**功能需要额外自建或用别人的(通过 JS 加载)。

从 v2 看到介绍文档系统帖子,一番研究对比.
有适合自建的文档系统推荐吗? – V2EX

各个 wiki 的对比说明
Compare Them All | WikiMatrix

2 bookstackapp

BookStack Demo
界面清晰,在线贴图, 支持强大
离线导入功能少.
数据在 mysql 里面,导出原始的文章不方便,只能出 pdf
国人 demo: 介绍 | 藏经阁
安装介绍: 一个非常棒的Wiki程序:BookStack-荒岛
是用书架->书籍->章节的方式组织的, 这点没有 wiki.js 方便.
权限方面: 设置关闭 public view 权限后, 隐藏文章名字, 这里不是我想要的. 我希望像 wiki.js 一样可以看到文章名字,但无法打开.
图片不能调整大小.

3 docsify.js

docsify
Issues · docsifyjs/docsify · GitHub
无后台, 部署简单. 直接把 md 文件贴到对应文件夹即可.
缺点: 要一个一个在_sidebar.md指定文件.–> 直接放弃

4 obsidian

通过 seafile 发布资料库,但只能是发布顶层文件夹, 不能指定权限.
Site Unreachable

5 wiki.js

权限管理很细致.
数据各种备份方式

参考国人介绍
用Wiki.js来优雅的管理文档
Wiki.js初体验_iTRunner-奔跑的猿的技术博客_51CTO博客
使用 Helm 部署 Wikijs_k8s_东风微鸣_InfoQ写作平台
部署过程:
Wiki.js:轻量级且功能强大的Wiki程序-荒岛

缺点:
传图麻烦, 不支持 paste image,而且 上传剪贴板的话, 图片名字都是 image.png.
新建文章要先新建 path, 再新建 fileName. 麻烦.
上传图片的需求 2020 年到现在都没解决.
Pictures copy paste from Word doesn’t work anymore · Discussion #3727 · requarks/wiki · GitHub

6 TiddlyWiki

单网页, 太折腾了….

7 wackowiki

这玩意就是最老的那种 wiki
Screenshots – WackoWiki

8 dokuwiki

老式经典 wiki
dokuwiki [DokuWiki]

9 showdoc

, 带客户端. –> 假的, 离线不能用
缺点:展示方法不喜欢. 编辑器不能自定义.
加[TOC]即可.
权限设定麻烦.
有水印

10 Docusaurus

搜索 | Docusaurus
静态, 不支持权限管理.
本地发布到 GitHub.

11 MkDocs

python 写的, 加分点.
默认的两个主题实时预览挺快的.
但其他主题就很慢了, 要部署为 html 后发布.

12 mrdoc

分个人和企业版.
个人版没用, 企业版 800rmb 买不起.

13 outline

功能完整,类 notion.
搭建复杂,太折腾.
图片不能缩放
⚠️ ☣️无法 直观分享文章列表, 只能分享单个文章. 放弃.
开源 wiki 和知识管理系统 Outline 的快速部署脚本 – V2EX
GitHub – outline/outline: The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
GitHub – vicalloy/outline-docker-compose: Install a self-hosted Outline wiki instance in a couple of minutes

14 confluence

权限一般, 占资源大.
编辑器很强大.

其他人的评价:1

title: Quote
   **Notion**:功能完美 · 颜值完美 · **无法私有化部署** · 网络环境有时不佳 · 半 Markdown · **数据难导出**
-   **Outline**:颜值高 · **部署异常困难**
-   **Trilium**:功能强大繁多 · 偏 Geek · **太丑** · 部署方便 · 半 Markdown · 数据可导出
-   **AppFlowy**:功能不完善 · 颜值高 · **不完善** · **只支持本地**
-   **为知笔记**:**功能简陋** · 颜值高 · 支持 Docker 私有化部署 · 不开源 · **私有格式不支持且不兼容 Markdown**
-   **AnyType**:功能强大 · 颜值高 · 理念先进 · **还没发布**
-   **思源笔记**:功能强大 · 颜值高 · 私有部署不支持多用户 · json 格式数据可导出

15 最终选用wordpress + mkdocs,优缺点说明.

15.1 权限控制

wordpress 额外安装了两个插件来控制权限. mkdocs 没有权限控制功能.

15.2 发布的繁琐程度

mkdocs 每次发布要重新 gen html 后手动上传到服务器. 其实和 wordpress 发布比,也不见得有优势.
[[mkdocs 配置笔记]] 记录我的配置过程

15.3 源码的保存方面:

mkdocs 能保存源码.
wordpress 要本地在 obsidian 保存 markdown 源码,然后通过 mweb 发布到 evernote 后发布到 wordpress 才能最大可能保留格式.

看来最终还是要用 wordpress 了.

  1. 七大私有化部署笔记&知识库系统横评 – SkyWT 

© 版权声明
THE END
在时间中留下我的脚印
分享