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

文章目录

    • @[toc]
  • 顶部
  • 1. 使用`[TOC]`自动生成
  • 2. VSCode中的插件
  • 3. 手搓目录
  • 目录
  • 相关资料
  • 本文相关代码
  • 一、概述
    • 1.1 基本概念
    • 1.2 两种处理模型
      • （1）微批处理
      • （2）持续处理
    • 1.3 Structured Streaming和Spark SQL、Spark Streaming关系
  • 二、编写Structured Streaming程序的基本步骤
  • 三、输入源
    • 3.1 File源
      • （1）创建程序生成JSON格式的File源测试数据
      • （2）创建程序对数据进行统计
      • （3）测试运行程序
      • （4）处理警告
      • （5）总结分析
    • 3.2 Kafka源
      • （1）启动Kafka
      • （2）编写生产者（Producer）程序
      • （3）安装Python3的Kafka支持
      • （4）运行生产者程序
      • （5）编写并运行消费者（Consumer）程序
        • 方式一
        • 方式二
      • 总结
    • 3.3 Socket源
    • 3.4 Rate源
  • surprise

顶部

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+P 或 F1，输入Markdown All in One: Create Table of Contents后回车即可
image

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

3. 手搓目录

接下来介绍如何手搓适用于GitHub的Markdown的结构的目录😎
以下为笔者的拙见，如有错误，请同志不吝指教
首先在编写目录之前请笔者明确目录结构
可以使用无序列表来实现目录的层级结构，之后就是创建链接锚点（每一个标题都是一个锚点），在目录的无序列表结构中使用[回到顶部](#顶部)这样的结构来链接到顶部标题，同理，链接到其他标题也是如此结构，如下：

语法效果
[回到顶部](#顶部)回到顶部

简单总结一下在GitHub编写README.md文件的规律总结：

  1. 标题处理:

    • 若标题为纯中文或中英文结合，无标点等特殊字符，直接用 # 加上标题名称，例如：# 一概述 对应 [一、概述](#一概述)。

  2. 特殊符号处理:

    • 若标题中包含中文符号如 、 或 （）等标点，则在链接中忽略这些标点，例如：# （1）微批处理 对应 [（1）微批处理](#1微批处理)。

  3. 数字结构处理:

    • 对于标题中含有类似 1.1 这样的结构，可以在链接中忽略 .或者吧.用-代替，例如：# 1.1 基本概念 对应 [1.1 基本概念](#11-基本概念)或[1.1 基本概念](#1-1-基本概念)。

  4. 空格处理:

    • 标题中的空格在链接中用 - 替代，例如：# 3.2 Kafka源 对应 [3.2 Kafka源](#32-kafka源)。

  5. 保持一致性:

    • 所有链接都采用小写字母和连字符风格，确保在Markdown中保持一致的链接格式。

下面结合一个实例来看：

目录

  • 相关资料
    • 本文相关代码
  • 一、概述
    • 1.1 基本概念
    • 1.2 两种处理模型
      • （1）微批处理
      • （2）持续处理
    • 1.3 Structured Streaming和Spark SQL、Spark Streaming关系
  • 二、编写Structured Streaming程序的基本步骤
  • 三、输入源
    • 3.1 File源
      • （1）创建程序生成JSON格式的File源测试数据
      • （2）创建程序对数据进行统计
      • （3）测试运行程序
      • （4）处理警告
      • （5）总结分析
    • 3.2 Kafka源
      • （1）启动Kafka
      • （2）编写生产者（Producer）程序
      • （3）安装Python3的Kafka支持
      • （4）运行生产者程序
      • （5）编写并运行消费者（Consumer）程序
        • 方式一
        • 方式二
      • 总结
    • 3.3 Socket源
    • 3.4 Rate源

相关资料

相关资料内容

本文相关代码

本文相关代码内容

一、概述

概述内容

1.1 基本概念

基本概念内容

1.2 两种处理模型

两种处理模型内容

（1）微批处理

微批处理内容

（2）持续处理

持续处理内容

1.3 Structured Streaming和Spark SQL、Spark Streaming关系

Structured Streaming和Spark SQL、Spark Streaming关系内容

二、编写Structured Streaming程序的基本步骤

编写Structured Streaming程序的基本步骤内容

三、输入源

输入源内容

3.1 File源

File源内容

（1）创建程序生成JSON格式的File源测试数据

创建程序生成JSON格式的File源测试数据内容

（2）创建程序对数据进行统计

创建程序对数据进行统计内容

（3）测试运行程序

测试运行程序内容

（4）处理警告

处理警告内容

（5）总结分析

总结分析内容

3.2 Kafka源

Kafka源内容

（1）启动Kafka

启动Kafka内容

（2）编写生产者（Producer）程序

编写生产者（Producer）程序内容

（3）安装Python3的Kafka支持

安装Python3的Kafka支持内容

（4）运行生产者程序

运行生产者程序内容

（5）编写并运行消费者（Consumer）程序

编写并运行消费者（Consumer）程序内容

方式一

方式一内容

方式二

方式二内容

总结

总结内容

3.3 Socket源

Socket源内容

3.4 Rate源

Rate源内容

上述内容的markdown代码为：

# **目录**
- [相关资料](#相关资料)- [本文相关代码](#本文相关代码)
- [一、概述](#一概述)- [1.1 基本概念](#11-基本概念)- [1.2 两种处理模型](#12-两种处理模型)- [（1）微批处理](#1微批处理)- [（2）持续处理](#2持续处理)- [1.3 Structured Streaming和Spark SQL、Spark Streaming关系](#13-structured-streaming和spark-sqlspark-streaming关系)
- [二、编写Structured Streaming程序的基本步骤](#二编写structured-streaming程序的基本步骤)
- [三、输入源](#三输入源)- [3.1 File源](#31-file源)- [（1）创建程序生成JSON格式的File源测试数据](#1创建程序生成json格式的file源测试数据)- [（2）创建程序对数据进行统计](#2创建程序对数据进行统计)- [（3）测试运行程序](#3测试运行程序)- [（4）处理警告](#4处理警告)- [（5）总结分析](#5总结分析)- [3.2 Kafka源](#32-kafka源)- [（1）启动Kafka](#1启动kafka)- [（2）编写生产者（Producer）程序](#2编写生产者producer程序)- [（3）安装Python3的Kafka支持](#3安装python3的kafka支持)- [（4）运行生产者程序](#4运行生产者程序)- [（5）编写并运行消费者（Consumer）程序](#5编写并运行消费者consumer程序)- [方式一](#方式一)- [方式二](#方式二)- [总结](#总结)- [3.3 Socket源](#33-socket源)- [3.4 Rate源](#34-rate源)# 相关资料
相关资料内容# 本文相关代码
本文相关代码内容# 一、概述
概述内容## 1.1 基本概念
基本概念内容## 1.2 两种处理模型
两种处理模型内容### （1）微批处理
微批处理内容### （2）持续处理
持续处理内容## 1.3 Structured Streaming和Spark SQL、Spark Streaming关系
Structured Streaming和Spark SQL、Spark Streaming关系内容# 二、编写Structured Streaming程序的基本步骤
编写Structured Streaming程序的基本步骤内容# 三、输入源
输入源内容## 3.1 File源
File源内容### （1）创建程序生成JSON格式的File源测试数据
创建程序生成JSON格式的File源测试数据内容### （2）创建程序对数据进行统计
创建程序对数据进行统计内容### （3）测试运行程序
测试运行程序内容### （4）处理警告
处理警告内容### （5）总结分析
总结分析内容## 3.2 Kafka源
Kafka源内容### （1）启动Kafka
启动Kafka内容### （2）编写生产者（Producer）程序
编写生产者（Producer）程序内容### （3）安装Python3的Kafka支持
安装Python3的Kafka支持内容### （4）运行生产者程序
运行生产者程序内容### （5）编写并运行消费者（Consumer）程序
编写并运行消费者（Consumer）程序内容#### 方式一
方式一内容#### 方式二
方式二内容### 总结
总结内容## 3.3 Socket源
Socket源内容## 3.4 Rate源
Rate源内容

🤡笔者发布文章后3分钟续写🤡
emm,笔者试了一下，笔者在编辑该文章时（即在编辑页面）是可以实现链接锚点跳转的，但不知为何，发布该文章后进入文章进行读取时无法实现通过手动编写的目录进行跳转，但是通过[TOC]生成的目录可以进行跳转。。。━━(￣ー￣*|||━━🤡👈🤣
笔者初步分析是因为笔者在写作时是在Markdown编辑器中进行的，所以使用markdown语法在编辑器中可以实现跳转功能，但是一旦发布后通过网页进行阅读并跳转时，网页是根据地址栏中的链接的参数进行定位的，故在阅读文章时能通过[TOC]生成的目录在浏览器中阅读时可以进行跳转,而不能通过使用手动编写的目录链接进行跳转。
如下：
点击[TOC]生成的目录进行跳转到1.1 基本概念时地址栏链接为https://www.cnblogs.com/wkkwk/p/18523776#tid-Wp58ZW

image

而使用手动编写的目录链接进行跳转到1.1 基本概念时地址栏链接为
https://www.cnblogs.com/wkkwk/p/18523776#11-基本概念
但是复制出来粘贴到记事本为
https://www.cnblogs.com/wkkwk/p/18523776#11-%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5
上述现象是由于URL编码造成的。在浏览器地址栏中，某些字符（例如中文字符和空格）会以可读的方式显示，而在实际的URL中，这些字符会被编码为特定的格式。（可以认为它俩是等价的）

image

写到这里，我突然有个想法，我将https://www.cnblogs.com/wkkwk/p/18523776#11-基本概念复制到新开的标签页的地址栏中，ai~，您猜怎么着，他跳转了到了对应标题处🤣🤣🤣，如下：

image

我心里顿时一万个cnm飘过，好在结果是好的，证明笔者写作的思路和内容是没有问题的🙆(❁´◡`❁)🙆

读者可以将文末代码块中的markdown代码复制到VSCode或Typora中进行测试！！！

surprise

笔者在此将家底双手奉上😎(❤️´艸｀❤️)，下列是一些有助于读者了解并熟练掌握Markdown语法与结构的网站分享：
Markdown教程|菜鸟教程
Markdown 基本语法
Markdown 基本语法 | Markdown 官方教程
README文件语法解读，即Github Flavored Markdown语法介绍
Markdown Emoji表情
同时也分享一个RGB颜色代码表🎨

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

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

[ shell 脚本实战篇 ] 编写恶意程序实现需求(恶意程序A监测特定目录B出现特定文件C执行恶意操作D-windows)

[ shell 脚本实战篇 ] 编写恶意程序实现需求(恶意程序A监测特定目录B出现特定文件C执行恶意操作D-windows)

🍬 博主介绍 👨‍🎓 博主介绍：大家好，我是 _PowerShell ，很高兴认识大家~ ✨主攻领域：【渗透领域】【数据通信】 【通讯安全】 【web安全】【面试分析】 🎉点赞➕评论➕收藏 养成习…
阅读更多...
攻克数字工具（GKData）在推动 AI 发展中的关键作用

攻克数字工具（GKData）在推动 AI 发展中的关键作用

摘要：本文深入探讨了攻克数字工具（GKData）对人工智能（AI）发展的重要推动作用，同时阐述了人工智能技术的发展历程、现状、应用领域和前景。分析了 GKData 在数据处理、模型训练与优化、算法创新等方面为 AI …
阅读更多...
Golang文件操作

Golang文件操作

1.文件介绍：文件是数据源，主要作用是保存数据 2.文件在程序中是以流的形式来操作的 对文件的操作主要用File(os包)结构体来实现 文件的基本操作 1）打开一个文件进行读操作： os.Open(name string)(*File,error) 2）关…
阅读更多...
WebSocket的理解与应用

WebSocket的理解与应用

WebSocket的理解与应用 一、是什么二、特点1、全双工2、二进制帧3、协议名4、握手5、优点 三、应用场景 一、是什么 WebSocket，是一种网络传输协议，位于OSI模型的应用层。可在单个TCP连接上进行全双工通信，能更好的节省服务器资源和带宽并达…
阅读更多...
【补题/atccoder】Toyota Programming Contest 2024#7（AtCoder Beginner Contest 362）

【补题/atccoder】Toyota Programming Contest 2024#7（AtCoder Beginner Contest 362）

A、买笔 思路&#xff1a; 输入红绿蓝三只笔价格&#xff0c;再输入不喜欢颜色&#xff0c; 输出除不喜欢颜色笔以外最低价格 代码如下&#xff1a; #include <iostream> #include <algorithm> using namespace std;int main() {int r, g, b;cin >> r >&…
阅读更多...
【含开题报告+文档+源码】基于Web的房地产销售网站的设计与实现

【含开题报告+文档+源码】基于Web的房地产销售网站的设计与实现

开题报告 随着经济的发展和城市化进程的加速&#xff0c;房地产市场逐渐成为人们关注的焦点。然而&#xff0c;传统的房地产销售模式存在很多问题&#xff0c;如信息不透明、交易过程繁琐、无法满足个性化需求等。这些问题不仅影响了消费者的购房体验&#xff0c;也制约了房地…
阅读更多...
网络层3——IP数据报转发的过程

网络层3——IP数据报转发的过程

目录 一、基于终点的转发 1、理解 2、IP数据报转发过程 二、最长前缀匹配 1、理解 2、主机路由 3、默认路由 三、二叉线索查找 一、基于终点的转发 1、理解 理解什么叫终点转发 IP数据报的传递&#xff0c;交给路由器后 可不可以做到直接发送给目的主机呢&#xff1f;…
阅读更多...
【LwIP源码学习4】主线程tcpip_thread

【LwIP源码学习4】主线程tcpip_thread

前言 本文对lwip的主要线程tcpip_thread进行分析。 正文 tcpip_thread是lwip最主要的线程&#xff0c;其创建在tcpip_init函数中 sys_thread_new(TCPIP_THREAD_NAME, tcpip_thread, NULL, TCPIP_THREAD_STACKSIZE, TCPIP_THREAD_PRIO);tcpip_init函数被TCPIP_Init函数调用。…
阅读更多...
前端的导入导出「CommonJS」「ES Module」模块化规范

前端的导入导出「CommonJS」「ES Module」模块化规范

模块化开发有助于我们将代码进行拆分&#xff0c;便于开发和维护&#xff0c;但如果不清楚模块化规范&#xff0c;就会在开发时不知道该用 require 还是 import&#xff0c;导出时该用 export 还是 module.exports 参考博主文章
阅读更多...
CoEdge: 面向自动驾驶的协作式边缘计算系统，实现分布式实时深度学习任务的高效调度与资源优化

CoEdge: 面向自动驾驶的协作式边缘计算系统，实现分布式实时深度学习任务的高效调度与资源优化

文章导读 CoEdge系统的构思基于边缘计算的发展&#xff0c;这一分布式计算范式将服务从云端推向网络边缘&#xff0c;以支持各种物联网应用&#xff0c;如智能交通和自动驾驶。随着通信技术的进步&#xff0c;出现了新的协作边缘系统&#xff0c;多个边缘节点可以通过本地点对…
阅读更多...
操作系统进程的描述与控制知识点

操作系统进程的描述与控制知识点

前趋图和程序执行 前趋图 定义&#xff1a; 前趋图是指一个有向无循环图&#xff0c;可记为 DAG&#xff0c;它用于描述进程之间执行的先后顺序图形表示&#xff1a; 程序的执行 程序顺序执行时&#xff0c;系统资源的利用率很低 程序顺序执行时的特征 顺序性封闭性可再现性 …
阅读更多...
移远通信推出八款天线新品，覆盖5G、4G、Wi-Fi和LoRa领域

移远通信推出八款天线新品，覆盖5G、4G、Wi-Fi和LoRa领域

近日&#xff0c;全球领先的物联网整体解决方案供应商移远通信宣布&#xff0c;再次推出八款高性能天线新品&#xff0c;进一步丰富其天线产品阵容&#xff0c;更好地满足全球客户对高品质天线的更多需求。具体包括5G超宽带天线YECT005W1A和YECT004W1A、5G天线YECT028W1A、4G天…
阅读更多...
k8s简单的指令以及图解

k8s简单的指令以及图解

k8s简单的操作指令 1.kubectl get pods 查看全部的pods 也就是k8s中的最小颗粒度 2.kubectl describe podsname 查看pod的详情 3.kubectl get pods -n podsname 查看pod服务是否正常 4.kubectl logs -f 容器name --tail1000 -n podname 查看pod 的日志 5.kubectl get service …
阅读更多...
Python复习1：

Python复习1：

一、数据类型 1.数字&#xff1a;int、float、bool 2.字符串&#xff1a;string 3.列表&#xff1a;list 4.集合&#xff1a;set 5.字典&#xff1a;dictionary 二、Test 1.print输出固定格式 num110 str1"hello world" #输出的固定格式 print("num1%d&…
阅读更多...
UVM验证该去大公司还是中型公司呢？

UVM验证该去大公司还是中型公司呢？

无论是UVM验证还是系统C验证亦或是其它&#xff0c;大公司的普遍特点是做过多层封装、已经准备好轮子、各式各样的工具库。如果一毕业就进大公司&#xff0c;那你会在UVM等基础之上再学习公司封装的那部分工具、脚本或者是库&#xff0c;一旦掌握以后你接下来将会脱离一些初级的…
阅读更多...
法律文件智能识别：免费OCR平台优化数字化管理

法律文件智能识别：免费OCR平台优化数字化管理

一、系统概述 在法律行业&#xff0c;纸质文件的数字化需求日益迫切&#xff0c;合同、判决书、协议等文件的管理成为法律部门的一大难题。传统手动输入不仅耗时&#xff0c;且易出错。思通数科的OCR识别平台应运而生&#xff0c;以其开源、免费的特性为法律文档管理提供了智能…
阅读更多...
koa + sequelize做距离计算（MySql篇）

koa + sequelize做距离计算（MySql篇）

1.核心思路 1.利用sequelize的fn方法调用MySql原生函数&#xff08;st_distance_sphere、point&#xff09; 2.这里利用到了MySql的原生函数&#xff0c;不懂可以去看看mysql的函数知识 2.核心代码 //st_distance_sphere、point函数用来计算当前经纬度和目的地经纬度 //col…
阅读更多...
小程序分包看完这一篇秒懂

小程序分包看完这一篇秒懂

前言 在小程序开发中&#xff0c;分包是一种优化加载时间和用户体验的方法。通过将小程序拆分成多个包&#xff0c;可以按需加载&#xff0c;从而减少首次加载时间。很多刚涉及小程序开发的小伙伴对小程序分包都相对茫然或者头疼。也不知道该合适进行分包&#xff0c;怎么进行…
阅读更多...
第02章 MySQL环境搭建

第02章 MySQL环境搭建

一、MySQL的卸载 如果安装mysql时出现问题&#xff0c;则需要将mysql卸载干净再重新安装。如果卸载不干净&#xff0c;仍然会报错安装不成功。 步骤1&#xff1a;停止MySQL服务 在卸载之前&#xff0c;先停止MySQL8.0的服务。按键盘上的“Ctrl Alt Delete”组合键&#xff0…
阅读更多...
1.探索WebSocket：实时网络的心跳！

1.探索WebSocket：实时网络的心跳！

序言 你可能听说过"WebSokcet"这个词&#xff0c;感觉它好像很高深&#xff0c;但其实它是一个超级酷的小工具&#xff0c;让我们在Web应用里实现实时通信。想象一下&#xff0c;你可以像聊天一样&#xff0c;在浏览器和服务器之间来回“畅聊“&#xff0c;没有延迟…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023