readme写作指南

最新推荐文章于 2024-04-29 15:29:14 发布
最新推荐文章于 2024-04-29 15:29:14 发布
阅读量250 收藏
点赞数
分类专栏： 软件工程 文章标签： MarkDown 软件工程
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/LittleDragorse/article/details/89463820
版权

文章目录

MarkDown基本语法

# 标题

HelloWorld

* or _ 斜体

HelloWorld

** or __ 加粗

HelloWorld

== 高亮

HelloWorld

~~ 删除线

不要啊

~ 下标

HelloWorld

^ 上标

HelloWorld

> 引用

Hello World

插入链接与图片

链接

[链接名](链接地址)
我的博客

图片:

![图片注释](图片链接)
Alt

插入代码段

```语言名
代码正文
```

# An highlighted block
foo = 'bar'

生成列表

  • 项目
    • 项目
      • 项目
LittleDragorse
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
README_readme_
10-01
A basic readme file for running benami games
README.md 文件的作用和语法
weixin_46243213的博客
07-29 4169
README.md 文件的作用和语法
README.md编写和格式语法——入门
最新发布
m0_68747642的博客
04-29 587
创建标题前加#符号来决定标题的大小。
README.md(markdown（纯文本笔记语法）)
C18304057755的博客
10-30 1199
三个星号*** ***内的文字 或 三个下划线___ ___，一个#代表一级标题，两个#代表二级标题，以此类推，右面得到预览效果。右侧有一个打开侧边预览，能看到渲染过的样式。如果需要流程图，需要加一个扩展插件如下。数学公式如图所示：遇到了查一查。新建文本文件，选择语言 ，案例如下，用的时候再学一学。
Github中Readme的编写基本规范
cryptocxf的博客
04-18 8132
README-Learning README是github上用来给读者快速理解作者本意的序言，个人理解感觉类似于“说明书”一样。它的排版非常简单，与CSDN中的编辑文本类似，可以直接在<>Edit file里面编写就行，然后Preview changes可以预览效果。下面是我个人整理的README语法学习记录，希望持续更新中！ 1. 文本换行 1.1 说明： 换行是我们写README第一个要使用的语法，不像word中直接按enter键就可以实现换行。在README中需要在某句话的末尾加上[空格]
README 语法
weixin_38222276的博客
07-15 517
#README介绍 #webpack webpack学习资料 <!--关于标题的写法有六个等级，显示的文本依次减小以井号#个数表示--> #一级标题 ######六级标题 <!--字体格式强调--> *强调* _强调_ **加重强调** __加重强调__ ***特别强调*** ___特别强调___ <!--代码--> `<div>写入代码</div>` <!--表...
软件项目规范（1）：README文件的基本写作规范
星羽空间
04-27 1万+
软件项目规范（1）：README文件的基本写作规范 本博客推出一款简约风格的README.md模板
guideline-readme:README.md 指南
06-04
指南自述文件 受启发的项目！ README 应该简单而简短，但是一个好的 README 可以节省时间，尤其是当它用于诸如命令行参数解析库之类的东西时。 话题 项目和所有子模块和库的名称（有时它们的名称不同，新用户很容易...
开源的readme.md编写工具
04-08
开源的readme.md编写工具。windows平台
readme.txt readme.txt
08-04
readme.txtreadme.txtreadme.txt
readme阅读软件
07-05
项目名及简介 好的项目名及简介是好项目必不可少的。开源项目名不宜过长（除非你有特别的理由这么做），如果你不知道如何给自己的项目起名，可以使用 随机项目名产生器（适用于 Javascript 项目）；项目简介可以是简单的几句话，但项目简介要说明几个你的开源项目用户想迫切了解的问题
README.md：README.md模板和示例
02-04
README.md：README.md模板和示例
linux reedme常用单词,Readme.md常用语法总结
weixin_28759987的博客
05-14 389
一、前言当我们在GitHub上了解别人的项目的时候，一般都是先看Readme.md，既然这样，如果我们想要让别人了解我们的项目，就不能随随便便地写Readme.md了。那Readme.md怎么写呢？Readme.md是有特定的语法规则的，称之为Markdown语法，我这里总结一些常用的语法，觉得有用就推荐一下吧。二、语法这里我先推荐一个在线的Markdown编辑器：https://stackedi...
如何为开发项目编写规范的README文件（windows），此文详解
诗筱涵的博客
11-25 1695
摘自：https://www.cnblogs.com/wj-1314/p/8547763.html 如何为开发项目编写规范的README文件（windows），此文详解 为什么要写这篇博客？ 　　其实我是一个入坑已经半年的程序员，因为不是计算机专业，只能自己摸索，所以我深知博客的重要性。每次我的学习笔记啊，项目的，面试题啊，有的，只要有时间，我肯定上传上来，一方面自己可以随时随地的看，另一方面也可以方便大家。 　　了解一个项目，恐怕首先都是通过其Readme文件了解信息。如果你以为Readm.
（转）为项目编写Readme.MD文件
weixin_30824479的博客
01-29 1365
转自http://www.coderli.com/write-readme-for-your-project/ 了解一个项目，恐怕首先都是通过其Readme文件了解信息。如果你以为Readme文件都是随便写写的那你就错了。github，oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的。称之为Markdown语法。基本规则如下： ...
GitHub上README写法暨GFM语法解读
weixin_30730053的博客
04-15 2622
转载请保留原作者guodongxiaren的原文地址。 自从开始玩GitHub以来，就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴，帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写，markdown是一种编辑博客的语言。用惯了可视化的博客编辑器（比如CSDN博客，囧），这种编程式的博客编辑方案着实...
Github README.md 添加分割线、换行
Dylan的博客
04-02 1万+
1、分割线 在需要进行分割的两行之间添加单独的一行内容： **** 2、文本换行 今天在README.md写好内容时，发现它缩到一起了，不是我想要的格式，怎么办呢？ 发现只要直接在要换行的语句最后打上2个空格，就是换行了。 ...
Markdown语法之如何使用中划线或删除线？
热门推荐
RunFromHere的博客
03-11 1万+
如何使用中划线或删除线 我是删除线 也可以叫做中划线 如何在markdown里实现这种效果呢？ 使用 '~~' 符号即可 ~~我是删除线~~
vscode readme
07-28
- *2* *3* [VS Code插件开发指南(view-readme)](https://blog.csdn.net/weixin_33739646/article/details/89065772)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值