一、开源项目简介

一个神奇的文档网站生成器。

可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。

二、功能概述

特性

  • 无需构建，写完文档直接发布
  • 容易使用并且轻量 (压缩后 ~21kB)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE11
  • 支持服务端渲染 SSR

部署支持

  • GitHub Pages
  • GitLab Pages
  • Gitee Pages
  • Firebase 主机
  • VPS
  • Netlify
  • ZEIT Now
  • AWS Amplify
  • Docker

兼容 Vue

你可以直接在 Markdown 文件里写 Vue 代码，它将被执行。我们可以用它写一些 Vue 的 Demo 或者示例代码。

首先，将 Vue2.x 或 3.x 添加到你的index.html文件中。

为你的站点选择合适的生产版本或开发版本，以获得有用的控制台警告和 Vue.js devtools 支持。

服务端渲染（SSR）

文档可依旧是部署在 GitHub Pages 上，Node 服务部署在 now.sh 里，渲染的内容是从 GitHub Pages 上同步过来的。所以静态部署文档的服务器和服务端渲染的 Node 服务器是分开的，也就是说你还是可以用之前的方式更新文档，并不需要每次都部署。

什么是 SSR?

SSR是 Server-Side Rendering(服务器端渲染)的缩写，简单的理解就是将平时写的组件，页面通过服务器生成HTML字符串，再发送到浏览器，最后将静态标记，混合为客户端上交互的应用程序。

  • 更好的 SEO
  • 更酷的感觉

三、技术选型

  • Node.js
  • Vue.js

四、界面展示

「开源」一个神奇的文档网站生成器，可生成在线/离线文档及电子书插图
「开源」一个神奇的文档网站生成器，可生成在线/离线文档及电子书插图1

五、开源协议

使用MIT开源协议

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。