IT评测·应用市场-qidao123.com

标题: 给自己的项目发布一个文档吧 [打印本页]
作者: 十念    时间: 2023-5-5 16:53
标题: 给自己的项目发布一个文档吧
给自己的项目发布一个文档

Github Page配置

在上一篇，我们搭建了一个脚手架，方便我们更快的开始一个项目。这篇我们将使用github page给这个项目发布一个文档
我们可以在 github 仓库的 Setting-Pages界面进行文档的设置，例如我这个仓库，把文档源设置成了当前仓库master分支的/docs目录，之后我们只需要往这个目录下添加静态文件就可以在对应的site展示文档了。


使用Docsify

使用Docsify能更方便地发布文档，只需要编辑md文件即可修改页面信息，因此我们使用docsify来构建文档
安装

首先你需要安装node.js，这里就不细说了
然后npm i docsify-cli -g 全局安装docsify-cli工具
docsify init ./docs初始化文档，我们设置的github page源是docs目录，所以初始化的是docs目录
初始化成功后会看到docs目录下会有几个文件
直接编辑README.me 就能更新文档内容了
本地查看

docsify serve docs即可在本地查看页面
配置

另外如果要对页面进行详细配置可以看官方文档和这篇文章，docsify，Docsify使用指南（打造最快捷、最轻量级的个人&团队文档） - 追逐时光者 - 博客园 (cnblogs.com)。
这里是我的配置文件以及最终效果
配置文件：https://github.com/weloe/go-web-demo/tree/master/docs
index.html
  1. <!DOCTYPE html>
  2. <html lang="en">
  4. <head>
  5.     <meta charset="UTF-8">
  6.     <title>go-web-demo</title>
  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  8.     <meta name="description" content="Description">
  9.     <meta name="viewport"
  10.         content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  11.         
  12.    
  13.     <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
  14. </head>
  16. <body>
  17.    
  18.     加载中...
  19.    
  20.    
  21.    
  22.    
  23.    
  24.    
  25.    
  26.    
  27.    
  28.    
  29.    
  30. </body>
  32. </html>
复制代码
最终效果
https://weloe.github.io/go-web-demo/#/

发布

当你配置完文件，直接push到github上时就会自动发布，前提是你按照文章开头设置了page
成功发布完后能在仓库的commit记录和仓库的Environments看到这两个



免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！



欢迎光临 IT评测·应用市场-qidao123.com (https://dis.qidao123.com/) Powered by Discuz! X3.4