V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
markyun

[程序员的知识传承 ] 自建知识库 & wiki 文档 & 静态网站生成框架 推荐

  •  
  •   markyun · Mar 18, 2024 · 2439 views
    This topic created in 776 days ago, the information mentioned may be changed or developed.

    初衷

    准备打造专属于程序员个人特征知识库与 Wiki (知识库是自己看的,wiki 对对外展示用),之前一直用语雀作为主要文档管理工具(包括团队级文档)。

    但随着量越来越大,并且想 DIY 的东西越来越多(比如在某些技术文档上加上 code 可运行的效果),而且有些知识文档属于团队业务机密的逻辑记录。

    方案

    于是准备把语雀知识库,使用 Node 导出 Markdown ,再通过自建文档库的方式+私有化部署,这样就不用受到服务商的任何限制了。

    这里放出我搜集和对比过的部分技术选型(+A 表示实践体验还不错,其他感觉中规中矩,亦或是不符合我的使用场景)。 看看大家还有没有更好的技术选型推荐。 还有语雀导出工具试了好几个,在量比较大的情况下,导出流程特别容易失败。

    自建知识库 & wiki 文档 技术选型

        ○ Docusaurus	(基于 React 生态系统)
        ○ Docsify 
        ○ Gitbooks	(有限制)
    
        ○ Vitepress   ( A ,主题自定义,菜单全自动生成插件)
        ○ MkDocs 	( A ,搭配 Material for MkDocs 主题)
        ○ hugo    ( A ,搭配自定义主题 )
    
        ○ Jekyll  (纯文档库用)
        ○ Astro	  (纯文档库用)
        ○ Hexo	  (纯文档库用)
        ○ Pagic	  (小众、静态站点生成,适合个人文档站点)
        ○ Docz 
        ○ confluence ( Wiki 文档管理平台,适合团队协作)
        ○ bisheng (阿里之前有开源项目用过,但不适用于我这种纯文档库)
        ○ dumi    (适用于 React 组件库)
    
    2 replies    2024-03-19 13:38:20 +08:00
    stevenshum
        1
    stevenshum  
       Mar 18, 2024   ❤️ 1
    我个人就用了 Material for MkDocs ,对于语雀的类书本结构 MkDocs 可以比较好适配,MkDocs 这方面也有一些做的很好的站点,例如 https://www.hello-algo.com/
    youngxhui838
        2
    youngxhui838  
       Mar 19, 2024
    文档型 可以使用 hugo + 主题 book https://themes.gohugo.io/themes/hugo-book/
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   2358 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 33ms · UTC 15:30 · PVG 23:30 · LAX 08:30 · JFK 11:30
    ♥ Do have faith in what you're doing.