o-book 2
o-book 2 是一个文档生成工具,它将会是你使用过的最简单的文档站生成工具之一。只需一个 HTML 文件,就可以将你编写的 Markdown 文章生成为功能完善的文档网站。它基于 ofa.js 开发,使用起来非常简单;
使用前的准备
在使用 o-book 之前,你需要掌握 Markdown 的基本语法。另外,你还需要准备一个文本编辑器。我们推荐使用微软推出的 VSCode,它不仅免费,而且有大量扩展可供选择,使你的文档编辑工作更加高效。
准备文件
在撰写文档之前,需要在本地准备好项目的基础文件。为了方便起见,我们已经为你提供了项目的初始文件,你只需点击以下链接下载并解压缩到本地即可:
后面我们会说明一下几个关键文件的含义;
运行项目
obook官方提供了三种方式运行你的项目,你可以根据需求选择其中一种方式启动即可:
- 标准模式:使用本地服务器查看 o-book 组件,从而预览和生成文档站。
- 命令行模式:使用 Node.js 和命令行预览和生成文档站。
- 网页应用模式:通过网页直接选择本地 Markdown 文件夹进行预览和生成。
标准模式 需要静态服务器打开下载好的文件;
命令行模式 需要有一定前端开发知识基础,通过 npm
安装 o-book
模块,后面就可以通过命令行进行预览和打包项目;这个模式也可以成为脚本自动化的一部分;
网页应用模式 不需要你有任何开发知识,只需要打开网站,选择本地文件夹,就能查看和打包你的项目;