mirror of
https://github.com/sipeed/sipeed_wiki.git
synced 2026-11-09 17:44:31 -06:00
402 lines
18 KiB
HTML
402 lines
18 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="zh" class=" md_page ">
|
||
|
||
<head>
|
||
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="keywords" content="">
|
||
<meta name="description" content="">
|
||
<meta name="generator" content="teedoc">
|
||
<meta name="theme" content="teedoc-plugin-theme-default">
|
||
|
||
|
||
<meta name="markdown-generator" content="teedoc-plugin-markdown-parser"><script>
|
||
MathJax = {"loader": {"load": ["output/svg"]}, "tex": {"inlineMath": [["$", "$"], ["\\(", "\\)"]]}, "svg": {"fontCache": "global"}};
|
||
</script><script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script><meta name="html-generator" content="teedoc-plugin-jupyter-notebook-parser"><meta name="blog-generator" content="teedoc-plugin-blog"><script src="/static/js/theme_default/pre_main.js"></script><link rel="stylesheet" href="/static/css/theme_default/viewer.min.css" type="text/css"/><link rel="stylesheet" href="/static/css/prism.css" type="text/css"/><link rel="stylesheet" href="/static/css/theme_default/dark.css" type="text/css"/><link rel="stylesheet" href="/static/css/theme_default/light.css" type="text/css"/><script src="/static/js/theme_default/jquery.min.js"></script><script src="/static/js/theme_default/split.js"></script><link rel="stylesheet" href="/static/css/search/style.css" type="text/css"/><script>
|
||
var _hmt = _hmt || [];
|
||
(function() {
|
||
var hm = document.createElement("script");
|
||
hm.src = "https://hm.baidu.com/hm.js?9cb07365544a53067c56c346c838181a";
|
||
var s = document.getElementsByTagName("script")[0];
|
||
s.parentNode.insertBefore(hm, s);
|
||
})();
|
||
</script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-119047820-5"></script>
|
||
<script>
|
||
window.dataLayer = window.dataLayer || [];
|
||
function gtag(){dataLayer.push(arguments);}
|
||
gtag('js', new Date());
|
||
|
||
gtag('config', 'UA-119047820-5');
|
||
</script><link rel="stylesheet" href="/static/css/gitalk/gitalk.css" type="text/css"/><link rel="stylesheet" href="/static/css/gitalk/custom_gitalk.css" type="text/css"/><link rel="stylesheet" href="/static/css/custom.css" type="text/css"/><link rel="stylesheet" href="/static/js/thumbs_up/style.css" type="text/css"/>
|
||
|
||
|
||
<title>Markdown 语法 - Sipeed Wiki</title>
|
||
|
||
|
||
|
||
<script type="text/javascript">js_vars = {"teedoc-plugin-ad-hint": {"type": "hint", "label": "NEW", "content": "<a href='https://www.kickstarter.com/projects/sipeed/slogic32u3-the-worlds-first-10gbps-usb32-logic-analyzer?ref=e0astc' target='_blank'>全球首款 10Gbps USB3.2 逻辑分析仪 SLogic32U3 正在 Kickstarter 众筹中！</a>", "show_times": 2, "show_after_s": 432000, "date": "2026-10-12 12:00", "color": "#a0421d", "link_color": "#e53935", "link_bg_color": "#e6ae5c", "bg_color": "#ffcf89", "color_hover": "white", "bg_color_hover": "#f57c00", "close_color": "#eab971"}, "teedoc-plugin-thumbs-up": {"label_up": "有帮助", "label_down": "待改进", "icon": "/static/images/thumbs_up/up.svg", "icon_clicked": "/static/images/thumbs_up/upped.svg", "url": "https://thumbs-up.sipeed.com", "show_up_count": true, "show_down_count": false, "msg_already_voted": "您已经投过票了", "msg_thanks": "感谢您的反馈", "msg_down_prompt": "感谢反馈，请告诉我们可以改进什么地方?（最少 10 个字）", "msg_down_prompt_error": "消息最少需要 10 个字， 最多 256 个字", "msg_error": "请求服务器出现错误!"}}</script>
|
||
<script type="text/javascript">metadata = {"tags": [], "date": false, "update": [], "ts": 0, "author": "", "brief": "", "cover": ""}</script>
|
||
</head>
|
||
<body class="type_page">
|
||
|
||
<div id="navbar">
|
||
<div id="navbar_menu">
|
||
<a class="site_title" href="/">
|
||
|
||
<img class="site_logo" src="/static/image/logo.svg" alt="sipeed wiki logo">
|
||
|
||
|
||
<h2>wiki</h2>
|
||
|
||
</a>
|
||
<a id="navbar_menu_btn"></a>
|
||
</div>
|
||
<div id="navbar_items">
|
||
<div>
|
||
<ul id="nav_left">
|
||
<li class=""><a href="/">产品</a></li>
|
||
<li class="sub_items "><a >开源软件</a><ul><li class=""><a href="/maixpy/">MaixPy</a></li>
|
||
<li class=""><a href="/soft/maixpy/zh/index.html">MaixPy_v1</a></li>
|
||
<li class=""><a href="/soft/Lichee/zh/index.html">Lichee</a></li>
|
||
<li class=""><a href="/ai/zh/index.html">AI 指南</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><a target="_blank" href="https://maixhub.com">MaixHub</a></li>
|
||
<li class=""><a href="/news/">动态</a></li>
|
||
<li class=""><a href="/faq.html">FAQ 汇总</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<ul id="nav_right">
|
||
<li class=""><a href="/store.html"><img src='/static/image/shop.svg' style='height: 1.5em;vertical-align: middle;'></a></li>
|
||
<li class=""><a target="_blank" href="https://github.com/sipeed"><img src='/static/image/github.svg' style='height: 1.5em;vertical-align: middle;'></a></li>
|
||
<li class="sub_items "><a ><img src='/static/image/language.svg' style='height: 1.5em;vertical-align: middle;'> 中文</a><ul><li class=""><a href="/en/markdown.html">English</a></li>
|
||
<li class="active"><a href="/markdown.html">中文</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
|
||
<ul class="nav_plugins"><li><a id="google_translate_element"><img class="icon" src="/static/image/google_translate/translate.svg"/>Translate</a></li></ul><ul class="nav_plugins"><li><a id="themes" class="light"></a></li></ul><ul class="nav_plugins"><li><a id="search"><span class="icon"></span><span class="placeholder">搜索</span>
|
||
<div id="search_hints">
|
||
<span id="search_input_hint">输入关键词，多关键词空格隔开</span>
|
||
<span id="search_loading_hint">正在加载，请稍候。。。</span>
|
||
<span id="search_download_err_hint">下载文件失败，请刷新重试或检查网络</span>
|
||
<span id="search_other_docs_result_hint">来自其它文档的结果</span>
|
||
<span id="search_curr_doc_result_hint">当前文档搜索结果</span>
|
||
</div></a></li></ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div id="page_wrapper">
|
||
<div id="page_content">
|
||
<div>
|
||
|
||
<p><strong>【<a href="../en/markdown.html" >English Version</a>】</strong></p>
|
||
<h2 id="Markdown-%E7%AE%80%E4%BB%8B">Markdown 简介</h2>
|
||
<p><code>Markdown</code> 是一种轻量级的标记语言，即用非常简单的字符来控制格式和排版，不用像类似 Word 的富文本编辑器一样费力使用鼠标来排版，并且文档是纯文本格式，方便修改和版本管理。</p>
|
||
<p>本文主要介绍如何了解和学习 <code>Markdown</code> 语法。</p>
|
||
<h2 id="Markdown-%E7%BB%84%E6%88%90">Markdown 组成</h2>
|
||
<p>Markdown 一般由一份<strong>纯文本内容</strong>和一个<strong>渲染器</strong>组成，纯文本就是按照 <code>Markdown</code>语法编写的文档，渲染器就是将纯文本内容转换为 HTML 等方便阅读的格式的工具。</p>
|
||
<p>一般在两种地方使用 <code>Markdown</code>:</p>
|
||
<ol>
|
||
<li>网站: 在网站填写内容时，如果支持 <code>Markdown</code>语法，可以直接使用 <code>Markdown</code> 语法来编辑内容，一般会有预览功能自动渲染。</li>
|
||
<li>离线工具，如 <code>Typora</code>，<code>VS Code</code> 等，这些工具一般都有预览功能，可以实时渲染。</li>
|
||
</ol>
|
||
<p><code>Markdown</code>语法就是用特殊的符号来控制格式，比如 <code>#</code> 表示标题，<code>[连接显示的文字](https://***)</code> 表示链接等。</p>
|
||
<h2 id="%E7%AE%80%E5%8D%95%E4%BE%8B%E5%AD%90">简单例子</h2>
|
||
<p>文本文件<code>test.md</code>：</p>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown"># 关于如何学习 Markdown 语法
|
||
|
||
## 什么是 Markdown
|
||
|
||
Markdown 一般由一份**纯文本内容**和一个**渲染器**组成，纯文本就是按照 `Markdown`语法编写的文档，渲染器就是将纯文本内容转换为 HTML 等方便阅读的格式的工具。
|
||
|
||
## Markdown 参考资料
|
||
|
||
1. [Basic Syntax](https://www.markdownguide.org/basic-syntax/)
|
||
2. [Markdown 基本语法](https://markdown.com.cn/basic-syntax/)
|
||
|
||
</code></pre>
|
||
<h2 id="%E5%AD%A6%E4%B9%A0-Markdown-%E8%AF%AD%E6%B3%95%E5%8F%82%E8%80%83">学习 Markdown 语法参考</h2>
|
||
<p>详细的参考以下网站，下面会简要列出基础和重要的语法：</p>
|
||
<ol>
|
||
<li><a href="https://www.markdownguide.org/basic-syntax/" target="_blank">Basic Syntax</a></li>
|
||
<li><a href="https://markdown.com.cn/basic-syntax/" target="_blank">Markdown 基本语法</a></li>
|
||
</ol>
|
||
<h3 id="%E6%A0%87%E9%A2%98">标题</h3>
|
||
<p>注意 <code>#</code> 后面有一个空格，而且为了兼容更多渲染器，尽量在一行标题后面加一个空行。</p>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown"># 一级标题
|
||
|
||
## 二级标题
|
||
|
||
### 三级标题
|
||
</code></pre>
|
||
<h3 id="%E6%AE%B5%E8%90%BD">段落</h3>
|
||
<p>段落之间用空行分隔</p>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">这是第一段。
|
||
|
||
这是第二段。
|
||
</code></pre>
|
||
<h3 id="%E5%AD%97%E4%BD%93">字体</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">*斜体*
|
||
**粗体**
|
||
~~删除线~~
|
||
</code></pre>
|
||
<p>效果：</p>
|
||
<p><em>斜体</em><br />
|
||
<strong>粗体</strong><br />
|
||
<del>删除线</del></p>
|
||
<h3 id="%E5%88%97%E8%A1%A8">列表</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">1. 有序列表，注意 1. 后面有一个空格
|
||
2. 有序列表
|
||
|
||
- 无序列表，注意 - 后面有一个空格
|
||
- 无序列表
|
||
|
||
* 无序列表，注意 * 后面有一个空格
|
||
* 无序列表
|
||
</code></pre>
|
||
<p>效果：</p>
|
||
<ol>
|
||
<li>有序列表，注意 1. 后面有一个空格</li>
|
||
<li>有序列表</li>
|
||
</ol>
|
||
<ul>
|
||
<li>无序列表，注意 - 后面有一个空格</li>
|
||
<li>无序列表</li>
|
||
</ul>
|
||
<ul>
|
||
<li>无序列表，注意 * 后面有一个空格</li>
|
||
<li>无序列表</li>
|
||
</ul>
|
||
<h3 id="%E5%BC%95%E7%94%A8%E6%AE%B5%E8%90%BD">引用段落</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">> 引用段落，也可以拿来做注释用，注意 > 后面有一个空格
|
||
</code></pre>
|
||
<blockquote>
|
||
<p>效果就是这样</p>
|
||
</blockquote>
|
||
<h3 id="%E4%BB%A3%E7%A0%81">代码</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">`单行代码`
|
||
</code></pre>
|
||
<p>效果：<code>单行代码</code></p>
|
||
<p>多行代码</p>
|
||
|
||
<pre class="language-none"><code class="language-none">```python
|
||
print("hello")
|
||
```
|
||
</code></pre>
|
||
<p>效果：</p>
|
||
|
||
<pre class="language-python"><code class="language-python">def hello():
|
||
print("hello")
|
||
|
||
hello()
|
||
</code></pre>
|
||
<h3 id="%E9%93%BE%E6%8E%A5">链接</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">[连接显示的文字，点击我调转到 MaixHub](https://maixhub.com)
|
||
</code></pre>
|
||
<p><a href="https://maixhub.com" target="_blank">连接显示的文字，点击我调转到 MaixHub</a></p>
|
||
<h3 id="%E5%9B%BE%E7%89%87">图片</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">
|
||
|
||
</code></pre>
|
||
<p>效果：<br />
|
||
<img src="/static/image/sipeed_logo.png" alt="图片显示的文字" /><br />
|
||
<img src="/static/image/sipeed_logo_4.svg" alt="图片显示的文字" /></p>
|
||
<h3 id="%E8%A1%A8%E6%A0%BC">表格</h3>
|
||
|
||
<pre class="language-markdown"><code class="language-markdown">| 表头1 | 表头2 |
|
||
| ----- | ----- |
|
||
| 内容1 | 内容2 |
|
||
</code></pre>
|
||
<p>效果：</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>表头1</th>
|
||
<th>表头2</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>内容1</td>
|
||
<td>内容2</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="%E5%85%B6%E4%BB%96">其他</h3>
|
||
<p>更多语法参考上面的参考资料。</p>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<a id="to_top" href="#"></a>
|
||
<div id="page_footer">
|
||
<div id="footer">
|
||
|
||
<div id="footer_top">
|
||
<ul>
|
||
<li><a>相关链接</a><ul><li><a target="_blank" href="https://www.sipeed.com">Sipeed 官网</a></li>
|
||
<li><a target="_blank" href="https://maixhub.com/">MaixHub</a></li>
|
||
<li><a target="_blank" href="https://sipeed.taobao.com/">Sipeed 淘宝</a></li>
|
||
<li><a href="/sitemap.xml">网站地图</a></li>
|
||
<li><a target="_blank" href="https://github.com/teedoc/teedoc">网站使用 teedoc 生成</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a>源码</a><ul><li><a target="_blank" href="https://github.com/sipeed/sipeed_wiki">Wiki 源码</a></li>
|
||
<li><a target="_blank" href="https://github.com/sipeed">开源项目</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a>关注我们</a><ul><li><a target="_blank" href="https://twitter.com/SipeedIO">twitter</a></li>
|
||
<li><a target="_blank" href="https://sipeed.taobao.com/">淘宝</a></li>
|
||
<li><a target="_blank" href="https://github.com/sipeed">github</a></li>
|
||
<li><a><a>微信公众号</a><img src='/static/image/wechat.png'></a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a>联系我们</a><ul><li><a>电话: +86 0755-27808509</a>
|
||
</li>
|
||
<li><a>商业支持: support@sipeed.com</a>
|
||
</li>
|
||
<li><a>地址: 深圳市宝安区新湖路4008号蘅芳科技办公大厦A座-2101D</a>
|
||
</li>
|
||
<li><a href="/join_us.html">加入我们</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div id="footer_bottom">
|
||
<ul>
|
||
<li><a target="_blank" href="https://www.sipeed.com">©2018-2023 深圳矽速科技有限公司</a></li>
|
||
<li><a target="_blank" href="https://beian.miit.gov.cn/#/Integrated/index">粤ICP备19015433号</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<script src="/teedoc-plugin-markdown-parser/mermaid.min.js"></script>
|
||
|
||
<script>mermaid.initialize({startOnLoad:true});</script>
|
||
|
||
<script type="text/javascript">
|
||
var transLoaded = false;
|
||
var loading = false;
|
||
var domain = "translate.google.com";
|
||
var domainDefault = domain;
|
||
var storeDomain = localStorage.getItem("googleTransDomain");
|
||
if(storeDomain){
|
||
domain = storeDomain;
|
||
console.log("load google translate domain from local storage:" + domain);
|
||
}
|
||
function getUrl(domain){
|
||
if(domain == "/")
|
||
return "/static/js/google_translate/element.js?cb=googleTranslateElementInit";
|
||
else
|
||
return "https://" + domain + "/translate_a/element.js?cb=googleTranslateElementInit";
|
||
}
|
||
var url = getUrl(domain);
|
||
console.log("google translate domain:" + domain + ", url: " + url);
|
||
function googleTranslateElementInit() {
|
||
new google.translate.TranslateElement({pageLanguage: "auto", layout: google.translate.TranslateElement.InlineLayout.SIMPLE}, 'google_translate_element');
|
||
}
|
||
function loadJS( url, callback ){
|
||
var script = document.createElement('script');
|
||
fn = callback || function(){ };
|
||
script.type = 'text/javascript';
|
||
if(script.readyState){
|
||
script.onreadystatechange = function(){
|
||
if( script.readyState == 'loaded' || script.readyState == 'complete' ){
|
||
script.onreadystatechange = null;
|
||
fn();
|
||
}
|
||
};
|
||
}else{
|
||
script.onload = function(){
|
||
fn();
|
||
};
|
||
}
|
||
script.src = url;
|
||
document.getElementsByTagName('head')[0].appendChild(script);
|
||
}
|
||
function removeHint(){
|
||
var hint = document.getElementById("loadingTranslate");
|
||
if(hint){
|
||
hint.remove();
|
||
}
|
||
}
|
||
var btn = document.getElementById("google_translate_element");
|
||
btn.onclick = function(){
|
||
if(transLoaded) return;
|
||
if(loading){
|
||
var flag = confirm("loading from " + domain + ", please wait, or change domain?");
|
||
if(flag){
|
||
newDomain = prompt("domain, default: " + domainDefault + ", now: " + domain);
|
||
if(newDomain){
|
||
domain = newDomain;
|
||
console.log(domain);
|
||
url = getUrl(domain);
|
||
loadJS(url, function(){
|
||
localStorage.setItem("googleTransDomain", domain);
|
||
removeHint()
|
||
transLoaded = true;
|
||
});
|
||
}
|
||
}
|
||
return;
|
||
}
|
||
btn.innerHTML = '<span id="loadingTranslate"><img class="icon" src="/static/image/google_translate/translate.svg"/>Loading ...</span>';
|
||
loading = true;
|
||
loadJS(url, function(){
|
||
localStorage.setItem("googleTransDomain", domain);
|
||
removeHint()
|
||
transLoaded = true;
|
||
});
|
||
}
|
||
</script>
|
||
|
||
|
||
<script src="/static/js/plugin_blog/main.js"></script>
|
||
|
||
<script src="/static/js/theme_default/tocbot.min.js"></script>
|
||
|
||
<script src="/static/js/theme_default/main.js"></script>
|
||
|
||
<script src="/static/js/theme_default/viewer.min.js"></script>
|
||
|
||
<script src="/static/js/prism.js"></script>
|
||
|
||
<script src="/static/js/search/search_main.js"></script>
|
||
|
||
<script src="/static/js/gitalk/gitalk.min.js"></script>
|
||
|
||
<script src="/static/js/gitalk/main.js"></script>
|
||
|
||
<link rel="stylesheet" href="/static/js/add_hint/style.css" type="text/css"/>
|
||
|
||
<script src="/static/js/add_hint/main.js"></script>
|
||
|
||
<script src="/static/js/custom.js"></script>
|
||
|
||
<script src="/static/js/thumbs_up/main.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |