首页 > 其他分享 >使用Markdown编写适用于GitHub的README.md文件的目录结构

使用Markdown编写适用于GitHub的README.md文件的目录结构

时间:2024-11-03 20:10:17浏览次数:4  
标签:md Markdown 程序 Kafka Streaming GitHub 内容 编写

目录


顶部

1. 使用[TOC]自动生成

在文档开头第一行单独输入[TOC],Markdown编辑器就会根据文档中的标题层级自动生成目录。在博客园和csdn中可以通过此方法来实现自动生成目录,但是要注意[TOC] 通常会生成文档中所有标题的目录。如果读者只想生成指定标题的目录(例如,前三个标题),只能手动创建一个自定义的目录,而不是使用自动生成的功能。
默认在GitHub中并不支持TOC的自动生成目录

2. VSCode中的插件

首先得有VSCode,在VSCode中下载Markdown All in One插件后,将需要编辑的Markdown文档使用VSCode打开进行编辑,按下万能键CTRL+SHIFT+PF1,输入Markdown All in One: Create Table of Contents后回车即可
image

该插件适用于GitHub中的Markdown的语法结构
现附上插件GitHub链接
v3.6.2下载链接
插件键盘快捷方式:
image

3. 手搓目录

接下来介绍如何手搓适用于GitHub的Markdown的结构的目录

标签:md,Markdown,程序,Kafka,Streaming,GitHub,内容,编写
From: https://www.cnblogs.com/wkkwk/p/18523776

相关文章

  • GitHub Copilot: the perfect Code compLeeter?
    全文总结这篇论文评估了GitHubCopilot生成的代码质量,基于LeetCode问题集,使用了一个自定义的自动化框架。研究背景背景介绍: 这篇文章的研究背景是GitHubCopilot在2021年发布,作为一个“AI配对编程员”,可以根据一些上下文(如注释、函数名或周围的代码)生成不同语言的代码。然......
  • 项目发布GitHub完全指南 - 从本地到开源
    引言将项目发布到GitHub不仅能方便版本管理,还能与全球开发者分享你的代码。本文将详细介绍如何将一个完整项目发布到GitHub的全过程,包括前期准备、具体操作步骤以及最佳实践。一、前期准备工作1.1环境准备安装Git#Windows用户可以下载Git官方安装包#Mac用户可以使用ho......
  • hexo 推送需要github的用户名
    问题描述hexo博客许久未写,今天尝试更新,发现hexod之后需要输入github的用户名和密码,但是我输入之后没有效果,还是无法推送到github上。研究之后发现rootcause是:github已经无法再用密码登陆推送,只能用token,而这里的token并不是ssh-keys里面的key,而是个人token。Sett......
  • [BJDCTF2020]Easy MD5
    题目链接:https://buuoj.cn/challenges#[BJDCTF2020]EasyMD5打开环境后如下所示。响应包如下。HTTP/1.1200OKServer:openrestyDate:Fri,25Oct202415:20:01GMTContent-Type:text/html;charset=UTF-8Connection:keep-aliveVary:Accept-EncodingX-Powered-By:......
  • MD5(Crypto)
    解题思路        打开文件发现一串代码,结合题目提示,应该是MD5加密。        找个在线的MD5解密网站,行云流水得到flag。题目设计原理题目设计:无他,MD5加密。题目原理:MD5(Message-DigestAlgorithm5):        一种广泛使用的哈希函数,它能够......
  • 关于Copilot出现:You don`t have access to Github Copilot .....的问题解决方案
    前面如何如何配置,以及如何如何上传学生证资料等我这里不赘述badendinghappyending出现这个界面这个问题就是set_up不是很完全,设置一下就行disable改为enable等这样再回去IDE,就可以正常使用了......
  • Markdown 链接
    链接的格式有两种,一种是<链接地址>另一种格式:[链接名称](链接地址)例如:这个链接用baidu作为网址变量百度 这个链接用JD作为网址变量京东 然后在文档的结尾为变量赋值(网址)[baidu] http://www.baidu.com/ [JD] http://www.jingdong.com/ ......
  • Markdown 列表
    Markdown列表学习无序列表使用星(*、加号+或是减号-作为列表标记,这些标记后面千万记得要添加一个空格,然后再填写内容,否则无效。+第一个项目+第二个项目-第一个项目-第二个项目*第一个项目*第二个项目效果图:·当然这是一级列表,还有2级列表,3级列表,需要再......
  • 如何使用GitHub上传文件
    使用GitHub上传文件的方法:1.创建GitHub仓库;2.使用GitHubDesktop上传文件;3.使用命令行上传文件;4.检查GitHub仓库。在开始之前,您需要一个GitHub账号。如果还没有账号,您可以在GitHub官方网站上注册一个。1.创建GitHub仓库在开始之前,您需要一个GitHub账号。如果还没有账号,您可以......
  • 阿里邮箱报错acdmodel-gemdb.dll?一文带你轻松应对阿里邮箱acdmodel-gemdb.dll报错的高
    在使用阿里邮箱时,如果遇到acdmodel-gemdb.dll报错,这可能会影响到你的邮件收发和其他相关功能。尽管acdmodel-gemdb.dll并非阿里邮箱的标准组件,但遇到此类错误时,不必过于担心。以下是一些高效且实用的解决方法,帮助你轻松应对这一报错。一、了解报错原因首先,需要明确acdmodel-......