Github + Jekyll 搭建项目wiki

网站托管

创建新仓库

创建以自己名字为前缀, .github.io​为后缀的仓库

image

在仓库的Settings中的Pages里设置Build and deployment​为Github Action

image

过一会即可跳转域名访问自己的页面

image

fork仓库

另外一种方法, 直接fork主题仓库,可以从官方主题这里获取更多。比如我使用的类似gitbook简约风格: sighingnow/jekyll-gitbook(使用了就给作者一个star), 然后把仓库名该成上述, 也是修改Build and deployment​为Github Action​, 等部署完毕:

image

本地调试

安装ruby

官网地址: rubyinstaller.org/downloads/, 下载后安装, 进入这里直接回车

image

安装RubyGems

官网地址:https://rubygems.org/pages/download, 下载解压, 到其目录下执行

ruby .\setup.rb 

image

完成后安装bundler​,jekyll

gem install bundler
gem install jekyll
jekyll -v

image

然后把自己的仓库拉下来,切换到目录下

jekyll server

image

报错缺少jekyll-feed

gem install jekyll-feed

image

然后还缺少以下, 安装后再次运行成功

gem install jekyll-readme-index
gem install jemoji
gem install webrick

image

然后访问url:

image

修改

先调整_config.yaml​, 如下是默认的, 可以看到我上面其实已经有了修改的, 以下自行修改

# Configurations
title:            Jekyll Gitbook
longtitle:        Jekyll Gitbook
author:           HE Tao
email:            sighingnow@gmail.com
description: >Build Jekyll site with the GitBook style.version:          1.0
gitbook_version:  3.2.3url:              'https://sighingnow.github.io'
baseurl:          '/jekyll-gitbook'
rss:              RSS# bootstrap: use the remote theme for the site itself
remote_theme: sighingnow/jekyll-gitbooktoc:enabled: trueh_min:   1h_max:   3# customize the link favicon in header, will be {{site.baseurl}}/{{site.favicon_path}}
favicon_path:     /assets/gitbook/images/favicon.ico# markdown render engine.
markdown:         kramdown
kramdown:auto_ids:               trueinput:                  GFMmath_engine:            mathjaxsmart_quotes:           lsquo,rsquo,ldquo,rdquotoc_levels:             1..6syntax_highlighter:     rougesyntax_highlighter_opts:guess_lang:           truesyntax_highlighter_style: colorfulmarkdown_ext:             markdown,mkdown,mkdn,mkd,md# Permalinks
permalink:                /:categories/:year-:month-:day-:title:output_ext# Disqus comments
# disqushandler:            sighingnowexclude:- _draftscollections:pages:output: truepermalink: /:collection/:path/others:output: truepermalink: /:collection/:path/ordered_collections:- posts- pages- otherspage_width: 800pxdestination:      ./_site
incremental:      false
regenerate:       trueplugins:- jekyll-feed- jekyll-readme-index- jemoji

添加文章

自己新建文章就要在根目录中的_posts​目录下创建markdown, 这里的markdown命名必须要符合其规范, 名称前加上前缀yyyy-mm-dd​, 比如: 2025-01-03-hi.md

图片路径

比如现在在本地部署显示, 那么图片的url可以填写为http:.//127.0.0.1:4000/base/assets/imgs/1.png​,其中base​为上面的_config.yml​中配置的baseurl​, 但这样不方便, 可以使用这样的写法:

{{site.baseurl}}/assets/imgs/login.png

image

部署

提交后用GitHub action部署时遇到了报错, 主要时这两个

  1. 平台不匹配Gemfile.lock​ 文件中的平台信息需要更新。
  2. Ruby 版本不兼容activesupport-8.0.1​ 要求 Ruby 版本 >= 3.2.0,而当前使用的 Ruby 版本是 3.1.4。

image

需要修改_config.yml​中的ruby-version​, 从原来的3.1​改为3.2.0​。然后更新​Gemfile.lock​ 文件以支持多个平台

bundle lock --normalize-platforms
bundle lock --add-platform x86_64-linux

image

最后

调整了一些样式也可以参考一下: 传送门

image

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/863415.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Postman安装及汉化教程 | 手把手教你轻松搞定

前言 Postman 是一款功能强大的 API 测试工具,深受开发者喜爱。然而,原版 Postman 是英文界面,对于习惯中文的用户可能不够友好。本教程详细介绍如何下载安装 Postman 并成功实现汉化,适合零基础用户。一、下载安装包 首先,获取 Postman 的安装包及对应汉化包: 👉 点击…

Postman安装及汉化操作全解(含图文步骤)

前言 Postman 是一款功能强大的 API 测试工具,深受开发者喜爱。然而,原版 Postman 是英文界面,对于习惯中文的用户可能不够友好。本教程详细介绍如何下载安装 Postman 并成功实现汉化,适合零基础用户。一、下载安装包 首先,获取 Postman 的安装包及对应汉化包: 👉 点击…

国产高性能CPU米尔瑞芯微RK3576赋能AIoT、工业、智能显示终端

随着市场需求不断的变化,各行各业对CPU的要求越来越高,特别是近几年流行的 AIOT,为了有更好的用户体验,CPU的算力就要求更高了。今天为大家推荐由米尔基于瑞芯微RK3576处理器推出的MYC-LR3576核心板及开发板。关于RK3576处理器国产CPU,是这些年的骄傲,华为手机全国产化,…

《IT项目管理》 - 课程笔记

Chapter 1. 项目管理概述 哪些是项目,哪些不是项目?为某银行客户开发、安装网上银行支付系统 √ 负责网上银行系统的销售工作 在2022年销售20套以上的网上银行系统 √ 为某银行的网上银行系统提供售后服务 建立客户售后服务热线 √ 管理售后服务热线,接听客户来电…

.net之阿里云短信服务集成

概念 集成阿里云短信服务 引用阿里云包封装AliyunSmsClient(二次封装阿里云短信基类)public class AliyunSmsClient{private readonly Client _client;private readonly AliyunSmsOptions _options;public AliyunSmsClient(IOptions<AliyunSmsOptions> options){_options…

Petalinux ARM设置自启动、自动加载驱动、自动挂载SD卡

一、在工程路径下新建app petalinux-create -t apps --template install -n myapp-init --enablepetalinux会在metausr目录下新建一个目录,结构如下 project-spec/meta-user/recipes-apps/myapp-init/ ├── files │ └── myapp-init ├── myapp-init.bb └── READM…

希捷移动硬盘开盘数据恢复之台州客户8T硬盘磁头突发损坏无法识别

这是一块8T的希捷3.5寸移动硬盘,浙江台州的老客户寄过来的,描述说是在公司正常使用的时候突然有异响,然后就不识别了,自己进行换数据线、换电脑等操作简单的排除了一下,确定是硬盘的故障,然后就联系我们中心邮寄过来进行数据恢复。收到硬盘后打开外壳,里面是一块型号为S…

云行 | “智”绘首都发展新篇章,天翼云携手伙伴共创“京”彩未来!

12月12日,以“智耀京华 焕新领航”为主题的天翼云中国行北京站活动圆满落幕。12月12日,以“智耀京华 焕新领航”为主题的天翼云中国行北京站活动圆满落幕。北京市经济和信息化局副局长刘维亮,中国电信股份有限公司北京分公司总经理寇凤达,天翼云科技有限公司助理总经理宫梅…

智能驾驶整车在环实验室SYNO解决方案

汽车行业智能化、网联化的发展趋势对智能网联车辆的测试验证手段提出了更高的要求。作为国内最早开展整车在环仿真测试技术预研的企业之一,经纬恒润从2016年开始整车在环仿真相关技术的预研工作。整车在环实现了从半实物仿真到机械混合仿真的跨步,将功能测试与性能测试整合,…

mac m3安装window11

1、安装虚拟机,本文使用vmware fusion13.6.2 软件下载地址 官网:https://www.vmware.com/products/desktop-hypervisor/workstation-and-fusion 1️⃣点击下载入口,跳转页面需要账号,没有账号可以走注册。正常按流程走注册即可 2️⃣登录进入,找到my downloads,点击下拉菜…

【linux合集】新开终端发现所有命令都无法执行。。。

场景描述: 在登录到机器的时候发现出现大量的command not found的情况,几乎无法执行除了export cd以外的所有命令,几乎无法执行所有命令的情况很无奈,然后发现可以执行history查看历史命令,随后通过history了解在此之前有操作过环境变量,这时候就在考虑是不是环境变量的情…

1.机械运动

1.1 长度和时间的测度 长度的单位及换算单位 表示 示例 备注米 m 100m 国际单位制 基本单位千米 km 1km 1km=1000m厘米 dm 10dm 10dm=1m厘米 cm 100cm 100cm=1m毫米 mm 10mm 10mm=1cm微米 μm 1000μm 1000μm=1mm纳米 nm 1000nm 1000nm=1μm刻度尺的认识及使用顺序 内容 操作要…