一些好用的静态文档网站生成框架

发表于 |

前言

对于开发者而言, 可能需要编写一些框架或者某个产品的使用说明文档, 一般这种文档都是系统化的由多个页面组成

此时如果使用博客的形式, 就显得比较零散不成体系, 我们如果将其整合成一个带目录的文档手册, 比如这种:

image-20230414122658260

image-20230414140619279

不仅让阅读者一目了然, 对于编写者而言也能起到规范作用

这种文档不仅适合开发者使用, 同样适合其他文字创作者, 比如作家, 小说家等等 对于普通人而言 一开始就使用这种文档式的创作模式能有效培养体系化的创作思维, 为未来创作长篇文章打下良好基础😁

好了 回归主题 如何快速生成这种静态文档网站呢?

这里给大家推荐几款框架

静态文档生成框架

  1. Docusaurus

    是Facebook专门为开源项目开发者提供的一款易于维护的静态网站创建工具,使用 Markdown即可更新网站

    官网: 点击进入

    Github: 点击进入

    image-20230418112631177

    示例网站: MPFlutter

    image-20230414140619279

  2. Gitbook

    示例网站: 面包多

    image-20230412122804341

  3. Read the Docs

    国外的一个文档托管网站

    官网: 点击进入

    image-20230418164731019

  4. VuePress

    官网: 点击进入

    Github: 点击进入

    一款由Vue驱动的静态网站生成器

    image-20230418110720504

  5. vuepress-theme-vdoing

    🚀一款基于VuePress修改和拓展的知识管理&博客(blog)主题

    官网: 点击进入

    Github: 点击进入

    image-20230418110531972

    示例网站: MyBatis-Plus, Variant Form

  6. VuePress Theme Hope

    一个具有强大功能的 vuepress 主题✨

    官网: 点击进入

    image-20230418162654493

    示例网站: FastRequest

大图镇楼

76024c75-2c5e-4787-b2f5-8c5fc32531d4

本文为作者原创转载时请注明出处 谢谢

乱码三千 – 点滴积累 ,欢迎来到乱码三千技术博客站

0%