Markdown[含GitHub]介绍与用法 - 学习/实践

比眉伴天荒 2023-05-22 06:35 34阅读 0赞

1.应用场景

<table> 
 <tbody> 
  <tr> 
   <td> <p>Markdown 应用</p> <p>Markdown 能被使用来撰写电子书，如：Gitbook。</p> <p>当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：<span style="color:#f33b45;">GitHub</span>、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。以及csdn平台.</p> </td> 
  </tr> 
 </tbody> 
</table>

2.学习/操作

<table> 
 <tbody> 
  <tr> 
   <td> <h2>文档参考</h2> 
    <blockquote> 
     <p><a href="https://www.runoob.com/markdown/md-advance.html" rel="nofollow">https://www.runoob.com/markdown/md-advance.html</a>&nbsp; // Markdown 教程</p> 
     <p><a href="https://yinxiang.com/new/hc/articles/%E5%8D%B0%E8%B1%A1%E7%AC%94%E8%AE%B0-markdown-%E5%85%A5%E9%97%A8%E6%8C%87%E5%8D%97/?utm_source=b1&amp;utm_medium=b1&amp;utm_term=c4lw3" rel="nofollow">https://yinxiang.com/new/hc/articles/印象笔记-markdown-入门指南/?utm_source=b1&amp;utm_medium=b1&amp;utm_term=c4lw3 </a>&nbsp;// 印象笔记 Markdown 入门指南</p> 
     <p><a href="https://blog.csdn.net/Erice_s/article/details/80202536" rel="nofollow">https://blog.csdn.net/Erice_s/article/details/80202536&nbsp; </a>// GihubMarkdown中的复选框按钮的实现</p> 
    </blockquote> <h2>1. 介绍</h2> 
    <blockquote> 
     <p>Markdown 是一种轻量级标记语言，它允许人们使用易读易写的<span style="color:#f33b45;">纯文本格式</span>编写文档。</p> 
     <p>Markdown 语言在 2004年 由约翰·格鲁伯（英语：John Gruber）创建。</p> 
     <p>Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。</p> 
     <p>Markdown 编写的文档后缀为 .md, .markdown。</p> 
    </blockquote> <h2>2.使用</h2> 
    <blockquote> 
     <p>可查看文档!</p> 
    </blockquote> <h2>3.常用的选项</h2> 
    <blockquote> 
     <p>TBD</p> 
    </blockquote> <h2>4.各平台常用</h2> <h3>&nbsp;4.1 github // 要严格书写, 多或者少一个空格都不行</h3> 
    <blockquote> 
     <p>- [ ] content<br> -空格[空格]空格content<br> 解释: [ ]括号里面的空格可以换成[x],代表选中对话框</p> 
    </blockquote> <p>preview</p> <p><img alt="" height="144" src="https://img-blog.csdnimg.cn/2020041614432660.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dpbGxpYW1fbg==,size_16,color_FFFFFF,t_70" width="264"></p> <p><span style="color:#f33b45;">模板推荐</span></p> 
    <blockquote> 
     <p>## Description<br> Showing ad type list when have data, if not, will show no-ad-type ui component.</p> 
     <p>## JIRA link<br> https://myseek.atlassian.net/browse/JAD-961</p> 
     <p>## This PR contains (select one)<br> - [ ] New Feature<br> - [x] Bugfix<br> - [ ] Refactor<br> - [ ] Test<br> - [ ] Chore (Other changes that don’t modify src or test files)<br> - [ ] Other (Please, specify)</p> 
    </blockquote> <p>截图如下：</p> <p><img alt="" height="553" src="https://img-blog.csdnimg.cn/2020111311524380.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dpbGxpYW1fbg==,size_16,color_FFFFFF,t_70" width="928"></p> <p></p> <p>预览：</p> <p><img alt="" height="616" src="https://img-blog.csdnimg.cn/20201113115306116.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dpbGxpYW1fbg==,size_16,color_FFFFFF,t_70" width="938"></p> <p></p> <p></p> <p><span style="color:#f33b45;"><strong>插入</strong> // 20210421 周三 公司</span></p> 
    <blockquote> 
     <p>如果想每次创建PR出现上述模板</p> 
     <p>则创建如下文件, 在项目根目录, 复制上面的信息到文件中~</p> 
     <p>.github/PULL_REQUEST_TEMPLATE.md</p> 
    </blockquote> <p>截图:</p> <p><img alt="" height="698" src="https://img-blog.csdnimg.cn/20210421172228273.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dpbGxpYW1fbg==,size_16,color_FFFFFF,t_70" width="1134"></p> <p></p> <p></p> <p></p> <p></p> <p>后续补充</p> <p>...</p> </td> 
  </tr> 
 </tbody> 
</table>

3.问题/补充

4.参考

<table> 
 <tbody> 
  <tr> 
   <td> <p><a href="https://www.runoob.com/markdown/md-advance.html" rel="nofollow">https://www.runoob.com/markdown/md-advance.html</a>&nbsp; // Markdown 教程</p> <p><a href="https://yinxiang.com/new/hc/articles/%E5%8D%B0%E8%B1%A1%E7%AC%94%E8%AE%B0-markdown-%E5%85%A5%E9%97%A8%E6%8C%87%E5%8D%97/?utm_source=b1&amp;utm_medium=b1&amp;utm_term=c4lw3" rel="nofollow">https://yinxiang.com/new/hc/articles/印象笔记-markdown-入门指南/?utm_source=b1&amp;utm_medium=b1&amp;utm_term=c4lw3 </a>&nbsp;// 印象笔记 Markdown 入门指南</p> <p><a href="https://blog.csdn.net/Erice_s/article/details/80202536" rel="nofollow">https://blog.csdn.net/Erice_s/article/details/80202536&nbsp; </a>// GihubMarkdown中的复选框按钮的实现</p> </td> 
  </tr> 
 </tbody> 
</table>

后续补充

...

![这里写图片描述][aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTgwMTMxMTE0ODQ0Mjg2]

[aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTgwMTMxMTE0ODQ0Mjg2]: /images/20230521/55db04be2be64b6f9b989b7a5e709c63.png