当前位置: 首页 > news >正文

记录一次部署Hugo主题lotusdocs到Github Pages实践

引言

  • 随着开源项目的越来越复杂,项目文档的重要性日渐突出。一个好的项目要有一个清晰明了的文档来帮助大家使用。
  • 最近一直有在找寻一个简洁明了的文档主题来放置项目的各种相关文档。最终找到这次的主角:Lotus Docs 基于Hugo的主题。Lotus Docs的样子,可以移步这里查看。
  • 下面着重讲解如何使用这个主题部署自己项目的文档。目前已经部署好的主题:LabelConvert 和 Knowledge-QA-LLM

分支说明

最终仓库下会有三个分支:

  • main: 项目源码
  • hugo_source: 放置主题和文档内容
  • gh-pages: 部署Github Pages的静态页面。Github Actions自动生成。

部署方法

以部署LabelConvert项目文档界面为例。

  1. 克隆项目main分支到本地
    git clone git@github.com:RapidAI/LabelConvert.git
    
  2. 新建hugo_source空白分支
    cd LabelConvert
    git checkout --orphan hugo_source
    git rm -rf .
    
  3. 克隆LabelConvert hugo_source分支到当前目录下
     git clone -b hugo_source git@github.com:RapidAI/LabelConvert.git# 将LabelConvert hugo_source中内容移到最外层目录,并删除LabelConvertmv LabelConvert/* .rm -r LabelConvert
    
  4. 更改content下内容为自己内容。这一步骤可以照猫画虎,更改对应内容即可。如果不会之处,可以参考主题说明文档
  5. 更改hugo.toml的相关内容为自己项目相关的内容
  6. 将项目的Github Actions功能打开。( Github → Actions → Enable)
  7. 提交hugo_source分支到Github
    # 先将remote改为自己的哈
    git remote remove origin
    git remote add origin your_git_address
    git push --set-upstream origin hugo_source
    
  8. 设置Github Pages部署的分支
    在这里插入图片描述
  9. 最终效果,可访问这里查看
http://www.lryc.cn/news/167559.html

相关文章:

  • stm32---基本定时器(TIM6,TIM7)
  • HTML网页设计
  • 阶段性总结:跨时钟域同步处理
  • [交互]接口与路由问题
  • linux 6中4T磁盘识别并分区格式化挂接
  • 【Unity】ShaderGraph应用(浮动气泡)
  • Android EditText setTranslationY导致输入法覆盖问题
  • MySQL 导出和导入数据
  • ubuntu22.04 设置网卡开机自启
  • 持续部署:提高敏捷加速软件交付(内含教程)
  • Spark_Spark内存模型管理
  • C++之operator=与operator==用法区别(二百一十八)
  • 【漏洞复现】WordPress插件wp-file-manager任意文件上传漏洞(CVE-2020-25213)
  • 基于安卓Java试题库在线考试系统uniapp 微信小程序
  • Java入坑之语法糖
  • VUE响应式
  • Godot 和 VScode配置C#环境注意事项
  • 三、Mediasoup进程通信实现的原理
  • 【计算机网络】 TCP——四次挥手
  • 「Java开发指南」在MyEclipse中的Spring开发(二)
  • 策略模式,一种广泛应用于各种情况的设计模式(设计模式与开发实践 P5)
  • 90. 子集 II
  • Intel汇编语言程序设计(第7版)第四章编程练习题答案
  • EDA(Exploratory Data Analysis)探索性数据分析
  • Python中的多媒体处理库有哪些?
  • LeetCode【28. 找出字符串中第一个匹配项的下标】
  • 产业互联网开始从简单的概念,逐渐成为可以落地的存在
  • element-ui tree组件实现在线增删改
  • 华为开源自研AI框架昇思MindSpore应用案例:消噪的Diffusion扩散模型
  • 华为CD32键盘使用教程