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

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

时间:2024-11-03 21:51:31浏览次数:3  
标签:md Markdown 程序 Kafka Streaming GitHub 内容 编写

文章目录

顶部

1. 使用[TOC]自动生成

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

2. VSCode中的插件

首先得有VSCode,在VSCode中下载Markdown All in One插件(使用Markdown All in One或Markdown Preview Enhanced皆可,此处以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://blog.csdn.net/qq_67822268/article/details/143471740

相关文章

  • Markdown语法
    注:"+"加号只表示信息组合,其本身无不参与Markdown语法组成标题:#+空格一级标题二级标题三级标题四级标题文字斜体:*+文字+*斜体加粗::**+文字+**加粗粗斜体:***+文字+***粗斜体段落有序列表:123+.+空格第一行第二行无序列表:-+空格第......
  • 冲一区!双重分解+粒子群优化+深度学习多元时序预测!CEEMDAN-Kmeans-VMD-PSO-Transformer
    目录效果一览基本介绍程序设计参考资料效果一览基本介绍1.Matlab实现CEEMDAN-Kmeans-VMD-PSO-Transformer融合K均值聚类的数据双重分解+粒子群优化+Transformer多元时间序列预测(完整源码和数据)运行环境Matlab2023b及以上。2.CEEMDAN分解,计算样本......
  • 安装LaTeX-OCR截图识别转换成LaTeX-Markdown格式
    安装LaTeX-OCR在虚拟环境中,通过pip命令安装LaTeX-OCR。以下是一个示例命令:pipinstallpix2tex[gui]注意:如果你在中国大陆地区,由于网络原因,可能需要设置临时代理或使用国内的镜像源来加速下载。使用LaTeX-OCR命令行使用安装完成后,你可以在命令行中直接使用LaTeX-OCR。首先,你......
  • 使用Markdown编写适用于GitHub的README.md文件的目录结构
    目录顶部1.使用[TOC]自动生成2.VSCode中的插件3.手搓目录目录相关资料本文相关代码一、概述1.1基本概念1.2两种处理模型(1)微批处理(2)持续处理1.3StructuredStreaming和SparkSQL、SparkStreaming关系二、编写StructuredStreaming程序的基本步骤三、输入源3.1File源(1)创建程......
  • 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,就可以正常使用了......