专业编程基础技术教程

网站首页 > 基础教程 正文

一个神奇的程序员专属文档生成工具

ccvgpt 2024-10-12 13:40:46 基础教程 9 ℃

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。

这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages

一个神奇的程序员专属文档生成工具

快速开始

推荐安装 docsify-cli 工具，可以方便创建及本地预览文档网站。

npm i docsify-cli -g

初始化项目

如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。

docsify init ./docs

开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

  • index.html 入口文件
  • README.md 会做为主页内容渲染
  • .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新网站内容，当然也可以写多个页面。

本地预览网站

运行一个本地服务器通过 docsify serve 可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://localhost:3000 。

docsify serve docs

更多命令行工具用法，参考 docsify-cli 文档。

手动初始化

如果不喜欢 npm 或者觉得安装工具太麻烦，我们其实只需要直接创建一个 index.html 文件。

index.html

<!DOCTYPE html>
<html>
<head>
 <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
 <meta name="viewport" content="width=device-width,initial-scale=1">
 <meta charset="UTF-8">
 <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
 <div id="app"></div>
 <script>
 window.$docsify = {
 //...
 }
 </script>
 <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>

如果系统里安装 Python 的话，也可以很轻易的启动一个静态服务器。

cd docs && python -m SimpleHTTPServer 3000

Loading 提示

初始化时会显示 Loading... 内容，你可以自定义提示信息。

index.html

 <div id="app">加载中</div>

如果更改了 el 的配置，需要将该元素加上 data-app 属性。

index.html

 <div data-app id="main">加载中</div>
 <script>
 window.$docsify = {
 el: '#main'
 }
 </script>

作者开源地址：https://github.com/docsifyjs/docsify
文档介绍：https://docsify.js.org

Tags：

猜你喜欢

最近发表
标签列表