码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • Github工程中的Markdown语言应用


    Github工程中的Markdown语言应用

    • 1. 介绍
    • 2. 工具
      • 2.1 下载链接
      • 2.2 编辑界面
      • 2.3 插件安装
    • 3. 基本操作
      • 3.1 标题编写
      • 3.2 正文编写
      • 3.3 代码块编写
      • 3.4 加粗倾斜
      • 3.5 有序列表
      • 3.6 无序列表
      • 3.7 行内代码编写
    • 4. 参考资料

    最早开源代码中,接触的最多的就是Readme文件,这种txt文件会提供必要的编译,打包,设计等。

    随着技术的发展,软件系统复杂度的提升,再快节奏的技术开发工作,尤其是组件化的模块应用。很多时候没法细细体会、阅读这些技术详细信息。

    我们知道在某些表达层面:

    • 视频 胜过 图
    • 图 胜过 表
    • 表 胜过 文字

    为了解决这个问题,但又要保留txt文档易于编辑和保存,差异化比较的优势,Markdown语法应运而生,且在GitHub开源项目和blog上得到大量应用。

    这里我们简单介绍Markdown入门,至于高阶,复杂的功能,相信大家接触的越多,自然而然会有更多体会,这里仅仅是个入门101介绍,希望对大家有帮助。

    1. 介绍

    Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

    Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。

    Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

    Markdown 编写的文档后缀为 .md, .markdown。

    2. 工具

    欲善其事必先利器,这里推荐一款常用的工具VS Code。

    2.1 下载链接

    Visual Studio Code
    VSC工具

    2.2 编辑界面

    左边栏:工程目录
    中间栏:编辑文件
    右边栏:文件预览
    工作界面

    2.3 插件安装

    这里有三个基本插件需要安装,安装完成后请重启VS code。

    VS code中文简体包
    Markdown All in One
    Markdown Preview Github styling

    3. 基本操作

    3.1 标题编写

    在这里插入图片描述

    3.2 正文编写

    在这里插入图片描述

    3.3 代码块编写

    在这里插入图片描述

    3.4 加粗倾斜

    在这里插入图片描述

    3.5 有序列表

    在这里插入图片描述

    3.6 无序列表

    在这里插入图片描述

    3.7 行内代码编写

    在这里插入图片描述

    4. 参考资料

    【1】Markdown教程
    【2】Visual Studio Code工具

  • 相关阅读:
    维格云身份认证入门教程
    node笔记记录28aynsc和await之3
    软件设计模式系列之十六——命令模式
    基于javaweb+mysql的宿舍管理系统
    Spring MVC单元测试笔记整理
    亚马逊、eBay,速卖通,国际站买家账号支付异常问题解决方法
    Vue3 使用v-md-editor如何动态上传图片了
    Gartner 发布 2022 年人工智能技术成熟度曲线:复合 AI、决策智能快速发展,因果 AI 是热点
    使用Tornado进行网络异步编程
    重温OKHTTP源码
  • 原文地址:https://blog.csdn.net/lida2003/article/details/127828153
  • 最新文章
  • 攻防演习之三天拿下官网站群
    数据安全治理学习——前期安全规划和安全管理体系建设
    企业安全 | 企业内一次钓鱼演练准备过程
    内网渗透测试 | Kerberos协议及其部分攻击手法
    0day的产生 | 不懂代码的"代码审计"
    安装scrcpy-client模块av模块异常,环境问题解决方案
    leetcode hot100【LeetCode 279. 完全平方数】java实现
    OpenWrt下安装Mosquitto
    AnatoMask论文汇总
    【AI日记】24.11.01 LangChain、openai api和github copilot
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1
正则表达式工具 cron表达式工具 密码生成工具

京公网安备 11010502049817号