Github的wiki编写

2023-05-16

全球最大的wiki,应该就是维基百科吧,其实百度百科,csdn写博客等等也是wiki,不久前自己接触了Github wiki的编写,因此做个记录吧

 

 

  • 模式一般选择Markdown,因为这个模式的功能是最多的。

 

  • 下图从左往右,分别编号为1到13

1 h1:Header 1,即一级标题,在文本中用 “# ”(#后面有一个空格)表示

2 h2:Header 2,即二级标题,在文本中用 “## ”(#后面有一个空格)表示

3 h3:Header 3,即三级标题,在文本中用 “### ”(#后面有一个空格)表示

4 Link:链接,例如把Github官网的链接可以这样写:

[Github](https://github.com)

5 Image:因特网上的图片链接

![图片代替文字](图片地址)  //原图显示


![图片代替文字](图片地址=LenthxWidth) //设置高宽

6 Bold:字体粗体

**要加粗的文字**

7 Italic:斜体

_要斜体的文字_

8 Code:代码

`代码写在这里`

9 Unordered List:无序列表,在行开头使用,在文本中用“* ”(*后面有一个空格)表示

10 Ordered List:有序列表,在行开头使用,在文本中用“1. ”(.后面有一个空格)表示,显示会默认将1自动自增,但是还是建议自己写

11 Blockquote:块引用,在行开头使用,在文本中用“> ”(>后面有一个空格)表示

12 Horizontal Rule:水平分割线,一行只有“***”(3个*)或“---”(3个-)在开头

13 Help:帮助

 

  • 换行

   换行可以在想换行的末尾添加斜杠 / 或者敲2个空格

这里是列示要换行的行末尾\
这里是列示要换行的行末尾  (2个空格)
最后一行不需要添加

 

  • 代码块:

 

    当一行的代码很长,不希望wiki里面把这一行代码分好几行显示的话,只显示一行,有个左右拉的scrollbar。 

    使用方法是空一 行,然后第二行行首4个空格。其实可以用这种方法完全代替8 Code的功能。 

    这是适用于代码不多的情况。  

 

    第二种方法是当代码很多行的时候,可以使用 两个 ``` ,这是最方便的: 

```

这里写代码

```

 

 

  • 表格

表格也是可以显示的,最方便的方法是到这个网址复制粘贴:表格剪贴板

​http://www.tablesgenerator.com/

在天朝学技术不容易,貌似要翻墙这个网址,直接把表格全选复制,然后在这个网址选好相应的行列粘贴即可

那么在wiki里面是怎么显示的呢,举个例子:

|  学号  |   名字  |  年龄  |  性别  |
|--------|--------|--------|-------|
|   01   |   牛牛 |  3     |    /  |

或者

|  学号  |   名字  |  年龄  |  性别  |
|:--------:|:--------:|:--------:|:-------:|
|   01   |   牛牛 |  3     |    /  |

记得间距对齐就行,显示的时候会自动生成一个表格

 

  • 下拉列表
<details>
  <summary>这里是下拉</summary>
  
  这里是下拉内显示的内容,记得先空一行
</details>

 

 

 

 

 

 

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Github的wiki编写 的相关文章

随机推荐

  • 【转载】K8S 问题排查:cgroup 内存泄露问题

    转载 K8S 问题排查 xff1a cgroup 内存泄露问题 原文 xff1a http www xuyasong com p 61 2049 前言 这篇文章的全称应该叫 xff1a 在某些内核版本上 xff0c cgroup 的 kme
  • 【可用】prometheus邮件报警配置

    参考 xff1a https github com prometheus alertmanager issues 384 参考 xff1a https github com easzlab kubeasz issues 448 使用QQ邮箱
  • 【案例】微服务-中台-业务关系图(来自processon)

    微服务 中台 业务关系图 知识云微服务架构 微服务开发平台规划架构图 微服务架构图 物联网微服务无业务架构 阿里中台技术在大型企业数字化转型的架构图 阿里中台战略笔记
  • prometheus监控域名证书到期时间

    参考 xff1a https mp weixin qq com s gXffcNzixAiTKSBZcf2sBA 最终效果图 xff1a 下面全部使用docker部署 xff1a 一 部署prometheus 这是一个默认的promethe
  • windows更新后无法上网问题(wifi和有线都不行)

    我真是个既倒霉又幸运的孩子 曾经 xff0c 有人在旁边抱怨 xff1a 该死的微软 xff0c 更新了一堆bug xff01 我没有理他 xff0c 因为它没有影响到我 xff0c 我很开心 曾经 xff0c 又有人在旁边抱怨 xff1a
  • 服务器上的 Git - Gitosis

    公司有这个东西 xff0c 之前一直没研究过这个是啥 xff0c 原来就是git的一个权限管理工具 xff0c 可以用来搭建git服务器 xff0c 当然gitlab更好用 具体请参考 xff1a 服务器上的 Git Gitosis 本篇文
  • MAC重装

    options 43 command 43 r xff0c 开机长按 xff0c 抹掉磁盘 xff0c 在线安装
  • 深度强化学习专栏 —— 3.实现一阶倒立摆

    我将文章发表在了古月居 xff0c 一起来看看吧 xff01 戳这里 猜你想看 xff1a 深度强化学习专栏 1 研究现状深度强化学习专栏 2 手撕DQN算法实现CartPole控制深度强化学习专栏 3 实现一阶倒立摆pybullet杂谈
  • mysql导入数据报错ERROR 1290 (HY000): The MySQL server is running with the --secure-file-priv option so it

    参考 xff1a https blog csdn net u011677147 article details 64129606 参考 xff1a http blog itpub net 31015730 viewspace 2152273
  • 第五章

    一 master节点生成密钥 发送至所有node节点 span class token punctuation span root localhost span class token punctuation span span class
  • linux中的&符号

    很好的文章 xff0c 文件描述符那个一直不是很懂 xff1a https www linux com blog learn 2019 2 ampersands and file descriptors bash https www lin
  • 三剑客20190714

    最后wordpress项目 xff1a main yml root 64 jenkins wordpress playbooks cat roles wordpress tasks main yml name Update yum depe
  • office2019中不包含onenote2016

    office2019中不包含onenote office2019中不包含onenote xff0c 而windows自带的onenote界面又大改 xff0c 完全不适应 xff0c 如何下载onenote2016 一 进入onenote下
  • kubernetes 1.15.1 高可用部署 -- 从零开始

    kubernetes 1 15 1 高可用部署 从零开始 晚点开始部署
  • prometheus和node_exporter部署

    监控体系 前面一篇文章对prometheus作了简单的入门了解 xff0c 在安装prometheus和node exporter之前先对监控体系做一下梳理 xff0c 更直观的讲可以分为iaas paas xff0c saas三个维度来说
  • ROS的一些基础的知识,自用

    零散小知识 先参考这个博客 再参考这个博客总结的知识点 查看当前所以发布的话题名 rostopic list 让ros一直调用回调函数 xff0c ros spin如下的代码无效函数 ros span class token operato
  • TMS320F28377X芯片can通信心得笔记(2)——流程细节

    一 xff0c 前言 补充上一篇文章 TMS320F28377X芯片can通信心得笔记 xff0c 之前一直找不到清晰又压缩的方式把图片缩小 二 xff0c 补充流程如图片和部分代码 带颜色 和带 号部分为中断配置 1 CAN配置部分代码
  • IDEA创建一个servlet项目

    1 File gt project gt java project 选中web application 如果选择java Enterprise可以免去后期导入servlet api jar包和配置Tomcat xff0c 但是需要在proj
  • STM32系列单片机的标准外设库、HAL库和LL库的区别和介绍

    本文转载自CSDN博客 xff1a ZCShouEXP xff0c 点击此处跳转至原博客 STM32 Embedded Software 工作以来一直使用意法半导体 xff08 ST xff09 的STM32系列MCU xff0c ST为开
  • Github的wiki编写

    全球最大的wiki xff0c 应该就是维基百科吧 xff0c 其实百度百科 xff0c csdn写博客等等也是wiki 不久前自己接触了Github wiki的编写 xff0c 因此做个记录吧 模式一般选择Markdown xff0c 因