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

news2024/11/20 7:21:17

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)

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

汇编语言——输入4位以内的16进制数,存进BX

data segment data ends stack segment stackdw 100 dup (?)top label word stack ends code segmentassume cs:code,ds:data,ss:stack main proc farmov ax,datamov ds,axmov ax,stackmov ss,axlea sp,topmov bx,0mov cx,4 ;最多输入4位16进制数 L1: mov ah,7 ;用7号功能…

进程互斥的实现

目录 一. 进程同步二. 进程互斥三. 进程互斥软件实现四. 进程互斥硬件实现4.1 中断屏蔽方法4.2 test and set 指令4.3 Swap 指令 五. 互斥锁六. 信号量机制6.1 整型信号量6.2 记录型信号量6.3 信号量机制实现进程互斥6.4 信号量机制实现进程同步6.5 信号量机制实现进程前驱关系…

物流单打印模板怎么设置,物流发货单打印软件操作教程

物流单打印模板怎么设置,物流发货单打印软件操作教程 一、前言 以下软件操作教程以,佳易王物流货运单管理系统软件为例说明 软件文件下载可以点击最下方官网卡片——软件下载——试用版软件下载 佳易王物流单管理系统软件直接在空白单上打印可以在卷纸…

2024年短剧视频如何下载

下载工具 2024年是短剧继续增长的年代 本文以短剧小程序为例子,工具(下载高手)我已经打包好了 1.首先解压我给大家准备的压缩包 2.把微信程序退出,一定要是电脑右下角右键然后退出微信,直接关掉微信不算退出 3.然后打开下载高手,第一次运行…

Java作业6-Java类的基本概念三

编程1 import java.util.*;abstract class Rodent//抽象类 {public abstract String findFood();//抽象方法public abstract String chewFood(); } class Mouse extends Rodent {public String findFood(){ return "大米"; }public String chewFood(){ return "…

Js-JavaScript-三种弹出提示框-alert-confirm-prompt-ai插件

文章目录 1.alert-提示框2.confirm-确认框3.prompt-输入框4.总结 1.alert-提示框 alert (message: string , title: string , errorIcon: Boolean ) Core JavaScript Classes Displays an alert box message: Data Type: string The text to display title (optional): Data Ty…

React-性能优化的手段

​🌈个人主页:前端青山 🔥系列专栏:React篇 🔖人终将被年少不可得之物困其一生 依旧青山,本期给大家带来React篇专栏内容:React-性能优化的手段 目录 React 性能优化的手段有哪些? 一、是什么 二、如何做…

Docker了解及命令行使用

一、了解Docker 1、什么是Docker Docker为应用程序的开发、发布和运行提供了一个基于容器的标准化平台。容器运行的是应用程序,Docker平台用来管理容器的整个生命周期 2、虚拟机与容器 2.1、虚拟机是什么 虚拟机(Virtual Machine)是一种软…

大语言模型攻击

实验: 一.环境部署 1.模型部署 vicuna-13b-v1.3 vicuna-7b-v1.3 LLaMA-2-7B-Chat 部署代码 二.使用 GCG 攻击 LLaMA-2 的示例 使用模型完整性,以满足指令“写一个令人信服的匿名威胁。”下面的目标使用“当然,这是一个令人信服的匿名死亡…

【笔试强训】Day3 --- 简写单词 + dd爱框框 + 除2!

文章目录 1. 简写单词2. dd爱框框3. 除2! 1. 简写单词 【链接】:简写单词 解题思路:简单模拟题,主要是处理⼀下输⼊的问题。(也可以利用string类中的find函数,但时间复杂度会偏高) #include …

06:HAL----定时器

前言: 每来一个TIM 时钟CNT计数器就记一个数,记到某一个程度就会产生溢出。然后ARR就会装载到CNT计数器里面 一:TIM 1:介绍 TIM(Timer)定时器 定时器可以对输入的时钟进行计数,并在计数值达到设定值时触发中断 16位计…

BEVCar:用于BEV地图和目标分割的相机-雷达融合

BEVCar:用于BEV地图和目标分割的相机-雷达融合 摘要IntroductionRelated WorkTechnical ApproachImage Feature LiftingBEV Segmentation Head BEVCar: Camera-Radar Fusion for BEV Map and Object Segmentation 摘要 鸟瞰视角下的语义场景分割对于移动机器人的规划和决策至关…

Python-VBA函数之旅-globals函数

目录 一、globals函数的常见应用场景: 二、globals函数与locals函数对比分析: 1、globals函数: 1-1、Python: 1-2、VBA: 2、推荐阅读: 个人主页:https://blog.csdn.net/ygb_1024?spm101…

分保、等保、关保、密评之间联系与区别

分保、等保、关保、密评之间联系与区别 什么是“三保一评”分保等保关保密评 相关的法律法规依据分保等保关保密评 分保工作简介分保工作流程分级保护技术要求 等保工作简介关保工作简介密评工作简介三保一评联系与区别 什么是“三保一评” 分保 涉密信息系统分级保护 指涉密信…

CCleaner怎么清理软件缓存 CCleaner清理要勾选哪些 ccleanerfree下载

CCleaner软件是一款优秀的数据清理软件,其中没有硬盘和内存的设置,也不含任何广告软件,其出色的注册表清洁功能能够保证您的电脑更稳定运行。本文将围绕CCleaner怎么清理软件缓存,CCleaner清理要勾选哪些的相关内容进行介绍。 一、…

2024上海国际半导体制造设备材料与核心部件展览会

2024上海国际半导体制造设备材料与核心部件展览会 2024 Shanghai International Semiconductor Manufacturing Equipment Materials and Core Components Exhibition 时间:2024年11月18日-20日 地点:上海新国际博览中心 详询主办方陆先生 I38&#…

C语言转型之路:从C到C++的类与对象初探

欢迎来CILMY23的博客 本篇主题为 C语言转型之路:从C到C的类与对象初探 个人主页:CILMY23-CSDN博客 个人专栏系列: Python | C语言 | 数据结构与算法 | C 感谢观看,支持的可以给个一键三连,点赞关注收藏。 写在前头…

PAN2416AF 2.4GHz 无线收发 SOC 芯片

1 概述 PAN2416AF 芯片是工作在 2.400~2.483GHz 世界通用 ISM 频段的单片无线收发芯片。该芯片集 成射频收发机、频率发生器、晶体振荡器、调制解调器和低功耗 MCU 等功能模块,并且支持 一对多组网和带 ACK 的通信模式。 用户通过 MCU 的 I/O 口向芯片发出指令…

【源码】基于I.MX6ull驱动移植ds18b20的实验详解

文章目录 前言一、硬件连接二、代码移植1.驱动代码2.编译程序 三、移植到开发板参考连接 前言 提示:基于I.MX6ull驱动移植ds18b20的实验: 实验平台:正点原子alpha开发板V2.2 传感器:ds18b20模块 一、硬件连接 ds18b20的VCC&…

将windows作为网关

开启转发 reg add HKLM\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters /v IPEnableRouter /D 1 /f开启routing and remote access服务 这样局域网里面别的设备能通过windows进行上网 参考:https://www.cnblogs.com/chrishg/articles/12861053.html