什么是 GitHub Wiki 以及如何使用它?

GitHub Wiki 是你项目文档的一个很好的地方。你可以使用 wiki 来创建、管理和托管你的存储库的文档,以便其他人可以使用并为你的项目做出贡献。

GitHub Wiki 很容易开始使用,无需安装任何其他软件。最好的部分是 wiki 与你的 GitHub 存储库集成在一起。

你不需要任何其他工具 - 你只需要知道如何使用 markdown,因为你将使用它来编写你的 wiki。

(本文视频讲解:java567.com)

如何开始使用 GitHub Wiki

你可以通过点击一次来开始你的 GitHub Wiki。每个 GitHub 存储库在页面顶部的菜单中都有一个 Wiki 选项卡。要开始,请点击它。

GitHub 存储库页面

有时在 GitHub 存储库导航栏中默认情况下不会显示 wiki 选项卡。首先,你需要在存储库设置中启用 wiki。

在这里插入图片描述

要做到这一点,进入你的存储库设置页面,向下滚动,并找到功能部分。然后通过勾选“Wikis”框启用 wikis。

启用 GitHub 中的 wiki

要在你的 GitHub 存储库中初始化 wiki,请在 wiki 中创建首页。

在 GitHub 中初始化 wiki。

当你点击“创建第一页”按钮时,你将被重定向到编辑页面,在那里你可以创建 wiki 中的首页。

在这里插入图片描述

你的 wiki 首页现在应该看起来像这样:

在这里插入图片描述

如何在本地克隆 GitHub Wiki

有时,新开发人员会困惑如何在本地克隆 wiki。要做到这一点,只需复制“本地克隆此 wiki”的链接,如下图所示:

复制克隆 GitHub wiki 的链接。

复制该链接并在你的笔记本电脑或机器上本地克隆 GitHub wiki 存储库。

现在,你可以在 wiki 中进行更改,例如本地编辑、更新或更改文档。在完成任何文档更改后,你可以将本地 wiki 文档推送到 GitHub wiki 存储库。

$ git clone https://github.com/officialrajdeepsingh/github-wiki-tutorial.wiki.git
Cloning into 'github-wiki-tutorial.wiki'...
remote: Enumerating objects: 6, done.
remote: Counting objects: 100% (6/6), done.
remote: Compressing objects: 100% (2/2), done.
remote: Total 6 (delta 1), reused 0 (delta 0), pack-reused 0
Receiving objects: 100% (6/6), done.
Resolving deltas: 100% (1/1), done.

在本地克隆存储库。

如何自定义你的 Wiki

Wiki 的侧边栏、首页和页脚的自定义选项有限。但是你可以使用 HTML、CSS 和 Markdown 来扩展这些选项。

我们已经讨论了首页,现在我们将讨论页脚和侧边栏。

页脚和侧边栏显示或包含诸如联系信息、导航链接、社交媒体链接等有用的链接。

页脚显示在站点的每个页面底部,侧边栏通常是网页左侧或右侧的垂直列。两者都在 wiki 的所有页面上可见。

如何创建自定义侧边栏

有两种方法可以在 GitHub wiki 中创建侧边栏。

  1. 使用 GitHub UI
  2. 在你的 IDE 中本地创建

我们将在这里看看每种方法,这样你就可以选择最适合你的方法。

使用 GitHub UI

创建侧边栏

转到 wiki 主页,然后点击“添加自定义侧边栏”按钮以在你的 wiki 中创建一个侧边栏。

接下来,它会重定向你到编辑页面以创建一个侧边栏页面。在侧边栏文件中,你可以编写 markdown 内容,比如导航链接等。然后,点击保存按钮

在 GitHub wiki 中创建 _Sidebar.md 文件。

在你的 IDE 中本地创建

第二种方法是在本地克隆你的 wiki,然后使用 VS Code 或其他你喜欢的 IDE 在 wiki 的根目录下创建一个 _Sidebar.md 文件。

如何创建自定义页脚

你将基本上按照侧边栏部分的步骤来创建自定义 wiki 页脚。

使用 GitHub UI

页脚

转到你的 wiki 页面,然后点击“添加自定义页脚”按钮以在你的 wiki 中创建一个页脚。

接下来,它会重定向你到编辑页面以创建一个页脚。在页脚文件中,你可以编写 markdown 内容,比如导航链接等。然后,点击保存按钮

在这里插入图片描述

在你的 IDE 中本地创建

第二种方法是在本地克隆你的 wiki,然后使用 VS Code 或其他你喜欢的 IDE 在 wiki 的根目录下创建一个 _Footer.md 文件。

什么是页面?如何在 Wiki 中创建新页面?

在 wiki 中,页面的功能类似于其他 CMS,让你有能力管理你的内容和文档。

通过 wiki 页面,你可以将你的内容或文档分成不同的部分,比如安装、配置等。

要创建一个新页面,请点击新页面按钮。

创建一个新的 wiki 页面

它会重定向你到编辑页面,在那里你可以添加标题和内容。在你的写作完成后,点击保存按钮。

创建一个 wiki 页面

在发布后,你的页面在 wiki 中看起来像这样:

在浏览器中发布后的 wiki 页面看起来像这样。

每个人都可以访问你的页面部分。你发布的每一页都会显示在你的 wiki 的页面部分中。

如何启用和禁用 Wiki 中的协作

要为每个人启用 wiki 中的协作,请转到你的 GitHub 存储库设置页面,向下滚动,找到功能,并取消选择“仅限协作者编辑”的复选框。

在 GitHub Wiki 中启用协作。在 GitHub Wiki 中启用协作。

你可以关闭 wiki 中的协作,以便你和你的团队是唯一负责更新、删除和编辑 wiki 的人员。

要做到这一点,你需要限制其他用户的编辑权限。启用仅限协作者编辑选项可以快速实现此目标。

在没有任何编辑后,邀请你的团队并给予他们访问权限。然后只需点击“仅限协作者编辑”复选框。

在这里插入图片描述
在 GitHub Wiki 中禁用协作。

为什么 GitHub Wiki 如此有用?

GitHub Wiki 对每个人都很有用。你可以在不到一分钟的时间内从 wiki 开始你的文档编写。你开始编写文档时,除了基本的 Markdown 语法知识外,什么都不需要。

使用 GitHub Wiki,你可以专注于编写基本的文档和项目本身。GitHub Wiki 处理了其余的文档工作,如托管问题、搜索等。最重要的是,对于公共存储库的 wiki,它是完全免费的。

现在许多著名的开源项目都使用 Wiki,如 hhvm、neovim、guard、[foundation db 等。

查看在 Wiki 中使用的项目列表。

结论

市场上有许多文档框架,如 Nextra、Lume、Starlight 和 Docusaurus。但是它们需要一些时间来学习、配置和设置。

此外,如果你仍在提升编码技能,对于诸如 React、MDX 等工具不太熟悉,你需要花一些时间学习它们,然后才能使用这些更高级的文档框架。

使用 GitHub Wiki,你可以立即开始创建你的文档,而不必担心部署和托管,这些都由 GitHub 管理。

GitHub Wiki 是小型和早期项目的绝佳选择。你和你的团队可以专注于项目,同时编写简单直接的文档。

(本文视频讲解:java567.com)

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

《九》Qt各种对话框之QColorDialog

前言 QColorDialog类继承于QDialog,是一个设计用来选择颜色的对话框部件。 QColorDialog 在介绍 QColorDialog 之前,我们先简单介绍一下 QColor 类。QColor 类用于表示颜色,支持 RGB(红绿蓝)三原色表示,也…

【C++】日期计算机

个人主页:救赎小恶魔 欢迎大家来到小恶魔频道 好久不见,甚是想念 今天我们要讲述的是一个日期类计算机的代码实现 引言: 我们日常生活中可能会有一个烦恼。 今天几月几号?过n天后又是几月几号?某年某月某天和x年…

PE文件的导入表,动态链接库中的函数应该如何导入

导入地址表IAT IAT保存的内容与windos操作系统的核心进程、内存、DLL结构有关。IAT是一种表格,用来记录程序正在使用哪些库中的哪些函数。 动态链接库(DLL) 常见的kernel.dll就是一个非常重要的动态链接库,其中包含了运行程序时需要使用到的函数&…

文件操作(1)

为什么使⽤⽂件? 如果没有⽂件,我们写的程序的数据是存储在电脑的内存中,如果程序退出,内存回收,数据就丢失了,等再次运⾏程序,是看不到上次程序的数据的,如果要将数据进⾏持久化的…

再谈C语言——理解指针(四)

assert断⾔ assert.h 头⽂件定义了宏 assert() ,⽤于在运⾏时确保程序符合指定条件,如果不符合,就报错终⽌运⾏。这个宏常常被称为“断⾔”。 assert(p ! NULL); 上⾯代码在程序运⾏到这⼀⾏语句时,验证变量 p 是否等于 NULL 。…

JavaScript 数学对象 Math

Math对象其实就是数学对象&#xff0c;它给我们提供了各种各样的数学功能。 <!DOCTYPE html> <html> <head><meta charset"UTF-8"><title>首页</title> </head><body><script type"text/javascript"&g…

linux的“>”和“>>”

在Linux中&#xff0c;>和>>都是用于文件重定向的操作符&#xff0c;它们用于将命令的输出发送到文件中。 > 用于创建一个新文件或覆盖现有文件的内容。当你执行一个如 command > file.txt 的命令时&#xff0c;如果 file.txt 文件存在&#xff0c;它的内容将被…

【uniapp】引入uni-ui组件库

&#xff08;1&#xff09;新建项目的时候选择 uni-ui项目 &#xff08;2&#xff09;已经创建好的项目去官网单独安装 跳转单独安装组件 https://uniapp.dcloud.net.cn/component/uniui/quickstart.html#%E9%80%9A%E8%BF%87-uni-modules-%E5%8D%95%E7%8B%AC%E5%AE%89%E8%A3%8…

YOLOv9训练损失、精度、mAP绘图功能 | 支持多结果对比,多结果绘在一个图片(消融实验、科研必备)

一、本文介绍 本文给大家带来的是YOLOv9系列的绘图功能&#xff0c;我将向大家介绍YOLO系列的绘图功能。我们在进行实验时&#xff0c;经常需要比较多个结果&#xff0c;针对这一问题&#xff0c;我写了点代码来解决这个问题&#xff0c;它可以根据训练结果绘制损失(loss)和mA…

VBA技术资料MF144:将PDF首页作为对象插入工作表

我给VBA的定义&#xff1a;VBA是个人小型自动化处理的有效工具。利用好了&#xff0c;可以大大提高自己的工作效率&#xff0c;而且可以提高数据的准确度。“VBA语言専攻”提供的教程一共九套&#xff0c;分为初级、中级、高级三大部分&#xff0c;教程是对VBA的系统讲解&#…

【C++】如何用C++写一个日期计算器

目录 前言 代码的布局 设计数据 方法声明 方法的实现 获取某年某月的天数 *全缺省的构造函数 * 拷贝构造函数 *赋值运算符重载 *析构函数 日期天数 日期天数 日期-天数 日期-天数 前置 后置 后置-- 前置-- 实现比较大小运算符重载思路 >运算符重载 运算…

盲人餐厅点餐:科技之光照亮餐桌上的美食之旅

在现代社会&#xff0c;餐厅不仅是满足口腹之欲的场所&#xff0c;更是一个社交、放松的重要空间。然而&#xff0c;对于视障人士而言&#xff0c;盲人餐厅点餐这一日常行为&#xff0c;却往往伴随着诸多不便与挑战。幸运的是&#xff0c;科技的革新正为这一群体带来前所未有的…

递归神经网络(RNN)在AI去衣技术中的深度应用

在人工智能&#xff08;AI&#xff09;技术飞速发展的今天&#xff0c;图像处理和计算机视觉领域不断取得新的突破。其中&#xff0c;AI去衣技术作为一个具有挑战性的研究方向&#xff0c;引起了广大研究者和公众的关注。递归神经网络&#xff08;RNN&#xff09;作为深度学习的…

【linux】编译器使用

目录 1. gcc &#xff0c;g 编译器使用 a. 有关gcc的指令&#xff08;g同理&#xff09; 2. .o 文件和库的链接方式 a. 链接方式 b. 动态库 和 静态库 优缺点对比 c. debug 版本 和 release 版本 1. gcc &#xff0c;g 编译器使用 a. 有关gcc的指令&#xff08;g同理&…

【第19章】spring-i8n

文章目录 前言一、准备二、Java国际化1.测试类2.测试结果 三、Spring国际化1.配置文件2.测试类3.测试结果4.占位符4.1 准备4.2 测试类4.3 测试结果 总结 前言 在Spring中实现国际化Internationalization&#xff08;i18n&#xff09;其实就是完成语言的切换&#xff0c;类似于…

4.SpringCloud基础项目搭建利用RestTemplate实现远程调用

简单的微服务架构 父pom.xml <?xml version"1.0" encoding"UTF-8"?><project xmlns"http://maven.apache.org/POM/4.0.0"xmlns:xsi"http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation"http://maven.apa…

短信视频提取批量工具,免COOKIE,博主视频下载抓取,爬虫

痛点&#xff1a;关于看了好多市面的软件&#xff0c;必须要先登录自己的Dy号才能 然后找到自己的COOKIE 放入软件才可以继续搜索&#xff0c;并且无法避免长时间使用 会导致无法正常显示页面的问题。 有没有一种方法 直接可以使用软件&#xff0c;不用设置的COOKIE的方法呢 …

Linux驱动开发:掌握SPI通信机制

目录标题 1、SPI简介2、SPI通信机制3、Linux内核中的SPI支持4、SPI核心API5、SPI控制器驱动6、SPI设备驱动 7、编写SPI设备驱动8、调试SPI驱动 在Linux驱动开发中&#xff0c;串行外设接口(SPI)是一种常见的高速全双工通信协议&#xff0c;用于连接处理器和各种外设。本文将深入…

会声会影滤镜怎么用 会声会影滤镜效果怎么调 会声会影视频制作教程

在进行视频剪辑时&#xff0c;合理地运用滤镜效果可以提升视频的观赏性&#xff0c;使你的作品更加出彩。这篇文章便一起来学习会声会影滤镜怎么用&#xff0c;会声会影滤镜效果怎么调。 一、会声会影滤镜怎么用 使用会声会影的滤镜效果非常简单&#xff0c;以下是具体的操作…

Rust腐蚀服务器定制地图开服

Rust腐蚀服务器定制地图开服 大家好我是艾西一个做服务器租用的网络架构师。Rust腐蚀这个游戏有很多的插件mod作者&#xff0c;在地图制作这一块也是一样&#xff0c;有些好玩的地图可能大家在map网站找到了但是不知道怎么操作设置那么今天艾西给大家说下特定定制地图怎么弄。…