chinese直男口爆体育生外卖, 99久久er热在这里只有精品99, 又色又爽又黄18禁美女裸身无遮挡, gogogo高清免费观看日本电视,私密按摩师高清版在线,人妻视频毛茸茸,91论坛 兴趣闲谈,欧美 亚洲 精品 8区,国产精品久久久久精品免费

0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

【經(jīng)驗(yàn)分享】如何使用Markdown編寫技術(shù)文檔?

嵌入式物聯(lián)網(wǎng)開發(fā) ? 來源:嵌入式物聯(lián)網(wǎng)開發(fā) ? 作者:嵌入式物聯(lián)網(wǎng)開發(fā) ? 2022-08-20 14:55 ? 次閱讀
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

1 概述

Markdown是一種輕量級標(biāo)記語言,創(chuàng)始人為約翰·格魯伯(英語:John Gruber)。 它允許人們使用易讀易寫的純文本格式編寫文檔,然后轉(zhuǎn)換成有效的XHTML(或者HTML)文檔。這種語言吸收了很多在電子郵件中已有的純文本標(biāo)記的特性。

由于Markdown的輕量化、易讀易寫特性,并且對于圖片,圖表、數(shù)學(xué)式都有支持,許多網(wǎng)站都廣泛使用Markdown來撰寫幫助文檔或是用于論壇上發(fā)表消息。 如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、簡書等,甚至還能被使用來撰寫電子書。

2 幾種支持Markdown語法的工具、軟件介紹

2.1 Typroa

Typroa 是我常用的編輯器,熟悉了Markdown語法了,你會用起來非常順手。它的設(shè)計(jì)與別人編輯器最大的區(qū)別是,它支持 “所見即所得”,一邊編寫,立馬就預(yù)覽,效率高,也很流暢。

特色功能:可以支持外部圖床設(shè)置,直接把截圖貼上來,立馬可以上傳到圖床,生成訪問鏈接,這個功能非常暫。

2.2 sublime插件

可以參考這個 鏈接 嘗試安裝看看,不過我試了,效果并不理想。

2.3 Cmd Markdown

這個有點(diǎn)特別,它既支持 在線網(wǎng)頁編輯器,也支持本地化的編輯器。采用的是左編輯、右預(yù)覽的設(shè)計(jì)。新手可以考慮使用下。

2.4 在線云筆記之類的平臺

有道云筆記:使用了,不太符合我的習(xí)慣;不過作為在線筆記倒是可以考慮。

語雀筆記:沒使用過,感興趣可以嘗試下。

印象筆記: 沒有使用過,感興趣可以嘗試下。

還有其他。。。

2.5 技術(shù)博客平臺的編輯器

常見的技術(shù)博客平臺,比如CSDN、簡書、博客園、oschina.net等都支持Markdown版本的編輯器。

2.6 總結(jié)

蘿卜青菜,各有所愛!選擇一款適合自己的,多使用,孰能生巧!

3 常用語法

3.1 目錄相關(guān)

1 這是1級目錄

1.1 這是2級目錄

1.1.1 這是3級目錄

1.1.1.1 這是4級目錄

1.1.1.1.1 這是5級目錄

1.1.1.1.1.1 這是6級目錄

注意,一般最大支持 6 級目錄,這樣滿足我們的日常寫作需求了。

3.2 文本相關(guān)

這個是加粗! 這個是斜體! 這個是斜體加粗! ~~這個是字體刪除!~~這個是文字加底色 (實(shí)則是代碼的寫法,下面會講)

3.3 列表相關(guān)

gg

gg

gg

ggg

gg

ggg

fff

有序列表4(加粗)

有序列表3

有序列表2

有序列表1 a. 有序列表 b. 有序列表

(數(shù)字 加 . 加 空格;支持多級嵌套)

無序列表

無序列表

哈哈哈

無序列表

無序列表

(-或*或+ 加 空格;支持多級嵌套)

3.4 代碼相關(guān)

這是單行代碼:printf("hello world!\r\n");

int main(void)

{

printf("hello world!\r\n");

return 0;

}

3.5 圖片相關(guān)

poYBAGMAhV2ABdFeAABGT5Pgq7c127.png

語法規(guī)則:

3.6 超鏈接相關(guān)

這里是百度的超鏈接描述

語法規(guī)則: 描述

3.7 文字引用

這是一段引用文字

引用可以嵌套

引用可以嵌套 這是一段引用文字

3.8 水平分隔線

【三個橫桿或三個星號或三個下劃線,+ 回車】

3.9 表格相關(guān)

(左對齊)表頭1 (居中)表頭2 (右對齊)表頭3 默認(rèn)表頭
內(nèi)容1 內(nèi)容2 內(nèi)容3 內(nèi)容4
~~內(nèi)容1~~ 內(nèi)容2 內(nèi)容3 內(nèi)容4

4 高階功能

4.1 to-do-list

[x] done-list-3

[x] done-list-2

[x] done-list-1

[ ] to-do-list-3

[ ] to-do-list-2

[ ] to-do-list-1

4.2 流程圖

st=>start: Start

op=>operation: Your Operation

cond=>condition: Yes or No?

e=>end

st->op->cond

cond(yes)->e

cond(no)->op

st=>start: 開始框

op=>operation: 處理框

cond=>condition: 判斷框(是或否?)

sub1=>subroutine: 子流程

io=>inputoutput: 輸入輸出框

e=>end: 結(jié)束框

st(right)->op(right)->cond

cond(yes)->io(bottom)->e

cond(no)->sub1(right)->op

st=>start: 開始框

op=>operation: 處理框

cond=>condition: 判斷框(是或否?)

sub1=>subroutine: 子流程

io=>inputoutput: 輸入輸出框

e=>end: 結(jié)束框

st->op->cond

cond(yes)->io->e

cond(no)->sub1(right)->op

4.3 時序圖

Alice->Bob: Hello Bob, how are you?

Note right of Bob: Bob thinks

Bob-->Alice: I am good thanks!

【注意:這個不是每個Markdown編輯器都支持的渲染功能】

Title: 標(biāo)題:復(fù)雜使用

對象A->對象B: 對象B你好嗎?(請求)

Note right of 對象B: 對象B的描述

Note left of 對象A: 對象A的描述(提示)

對象B-->對象A: 我很好(響應(yīng))

對象B->小三: 你好嗎

小三-->>對象A: 對象B找我了

對象A->對象B: 你真的好嗎?

Note over 小三,對象B: 我們是朋友

participant C

Note right of C: 沒人陪我玩

4.4 甘特圖

title 項(xiàng)目開發(fā)流程

section 項(xiàng)目確定

需求分析 :a1, 2016-06-22, 3d

可行性報(bào)告 :after a1, 5d

概念驗(yàn)證 : 5d

section 項(xiàng)目實(shí)施

概要設(shè)計(jì) :2016-07-05 , 5d

詳細(xì)設(shè)計(jì) :2016-07-08, 10d

編碼 :2016-07-15, 10d

測試 :2016-07-22, 5d

section 發(fā)布驗(yàn)收

發(fā)布: 2d

驗(yàn)收: 3d

【注意:這個不是每個Markdown編輯器都支持的渲染功能(Cmd Markdown 的 gantt語法)】

%% 語法示例

gantt

dateFormat YYYY-MM-DD

title 軟件開發(fā)甘特圖

section 設(shè)計(jì)

需求 :done, des1, 2014-01-06,2014-01-08

原型 :active, des2, 2014-01-09, 3d

UI設(shè)計(jì) : des3, after des2, 5d

未來任務(wù) : des4, after des3, 5d

section 開發(fā)

學(xué)習(xí)準(zhǔn)備理解需求 :crit, done, 2014-01-06,24h

設(shè)計(jì)框架 :crit, done, after des2, 2d

開發(fā) :crit, active, 3d

未來任務(wù) :crit, 5d

耍 :2d

section 測試

功能測試 :active, a1, after des3, 3d

壓力測試 :after a1 , 20h

測試報(bào)告 : 48h

【注意:這個不是每個Markdown編輯器都支持的渲染功能(Typroa 的 mermaid語法)】

4.5 數(shù)學(xué)公式

這是單行公式$E=mc^2$

$\sin(\alpha)^{\theta}=\sum_{i=0}^{n}(x^i + \cos(f))$

$$ E=mc^2 $$

$$ \sin(\alpha)^{\theta}=\sum_{i=0}^{n}(x^i + \cos(f)) $$

5 注意事項(xiàng)

5.1 空格問題

Markdown對空格是不敏感的,也就是說你想輸入空格顯示的時候,還需要特殊操作,比如首行空兩個的寫作場景。

? 半角的空格 ? 全角的空格

5.2 換行問題

操作方法

行尾打兩個或兩個以上的空格之后回車(換行后的行距較?。?/p>

打兩個回車 (換行之后的行距變大)

html的
來換行 (比較兼容的寫法)

這是一行
這是另一行 這是第3行

這是一行

這是另一行

這是第3行

這是一行
這是另一行
這是第3行

5.3 字符轉(zhuǎn)義的問題

在 HTML 文件中,有兩個字符需要特殊處理: < 和 & 。 < 符號用于起始標(biāo)簽,& 符號則用于標(biāo)記 HTML 實(shí)體,如果你只是想要使用這些符號,你必須要使用實(shí)體的形式,像是 < 和 &。

這里舉兩個例子:

AT&T AT&T

4 < 5 4 < 5

5.4 內(nèi)嵌 HTML 標(biāo)簽的問題

我也不熟,很少有,舉個例子:

這是紅色字體

這是綠色字體

字體大小size=1

字體大小size=3

字體大小size=5

【注意:以上html標(biāo)簽有些編輯器又不支持】



審核編輯:劉清

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點(diǎn)僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請聯(lián)系本站處理。 舉報(bào)投訴
  • 嵌入式技術(shù)
    +關(guān)注

    關(guān)注

    10

    文章

    366

    瀏覽量

    43344
  • 編輯器
    +關(guān)注

    關(guān)注

    1

    文章

    826

    瀏覽量

    32795
  • MarkDown
    +關(guān)注

    關(guān)注

    0

    文章

    46

    瀏覽量

    610
收藏 人收藏
加入交流群
微信小助手二維碼

掃碼添加小助手

加入工程師交流群

    評論

    相關(guān)推薦
    熱點(diǎn)推薦

    【社區(qū)之星】向愨——通過文檔來梳理自己的思路,讓自己思維更細(xì)致,更規(guī)范

    是在第二份工作,也讓我在機(jī)器人,工控行業(yè)扎了根,確定了自己的方向。第三份工作是雖然技術(shù)沒有太多的更新,但是卻得到了沉淀以及項(xiàng)目管理經(jīng)驗(yàn)。讓我有了寫文檔的習(xí)慣,通過文檔來梳理自己的思路,
    發(fā)表于 12-19 10:35

    還在用PDF文檔查資料?飛凌嵌入式「產(chǎn)品在線文檔」讓您的開發(fā)效率狂飆

    產(chǎn)品在線文檔以版本迭代的實(shí)時性、內(nèi)容檢索的高效性、場景適配的兼容性、互動體驗(yàn)的連接性,解決了傳統(tǒng)PDF手冊的痛點(diǎn),大大提升了用戶獲取信息的效率,讓技術(shù)支持服務(wù)質(zhì)量更進(jìn)一步! >>點(diǎn)擊這里,即可訪問飛凌嵌入式在線文檔
    發(fā)表于 09-26 08:57

    電子發(fā)燒友工程師看!電子領(lǐng)域評職稱,技術(shù)之路更扎實(shí)

    案例”,行業(yè)影響力大幅提升。? 更關(guān)鍵的是,評職稱能倒逼技術(shù)人系統(tǒng)化提升能力。為滿足評審要求,咱們會主動梳理項(xiàng)目經(jīng)驗(yàn)(如整理電路設(shè)計(jì)文檔、提煉技術(shù)難點(diǎn)解決方案)、補(bǔ)充理論知識(如學(xué)習(xí)電
    發(fā)表于 08-20 13:53

    鴻蒙開發(fā)如何顯示Markdown格式語法 -- markdown_hm介紹

    在開發(fā)過程中,對于內(nèi)容的展示通常有富文本和Markdown兩種,后者更偏向于技術(shù)文檔、說明書一類的內(nèi)容展示。但是和富文本不同的是,沒有一個原生組件可以用來解析展示Markdown語法的
    發(fā)表于 06-30 18:47

    精準(zhǔn)同步背后的科學(xué):標(biāo)準(zhǔn)時間網(wǎng)絡(luò)的運(yùn)維經(jīng)驗(yàn)解析

    在現(xiàn)代社會,標(biāo)準(zhǔn)時間同步時鐘網(wǎng)絡(luò)是金融、電力、通信等行業(yè)的核心基礎(chǔ)設(shè)施之一。它的精準(zhǔn)性不僅依賴于先進(jìn)的技術(shù),更離不開長期的運(yùn)維經(jīng)驗(yàn)積累。本文將探討標(biāo)準(zhǔn)時間同步網(wǎng)絡(luò)在實(shí)際應(yīng)用中的關(guān)鍵經(jīng)驗(yàn),揭示其穩(wěn)定運(yùn)行背后的科學(xué)邏輯。
    的頭像 發(fā)表于 06-30 14:42 ?502次閱讀
    精準(zhǔn)同步背后的科學(xué):標(biāo)準(zhǔn)時間網(wǎng)絡(luò)的運(yùn)維<b class='flag-5'>經(jīng)驗(yàn)</b>解析

    升壓電路一文搞懂 升壓電路技術(shù)文檔合集

    升壓電路圖集合,升壓電路設(shè)計(jì)方案,電路設(shè)計(jì)技巧,升壓電路一文搞懂;給大家分享 升壓電路技術(shù)文檔合集
    的頭像 發(fā)表于 05-15 15:58 ?2.1w次閱讀
    升壓電路一文搞懂 升壓電路<b class='flag-5'>技術(shù)</b><b class='flag-5'>文檔</b>合集

    ESD技術(shù)文檔:芯片級ESD與系統(tǒng)級ESD測試標(biāo)準(zhǔn)介紹和差異分析

    ESD技術(shù)文檔:芯片級ESD與系統(tǒng)級ESD測試標(biāo)準(zhǔn)介紹和差異分析
    的頭像 發(fā)表于 05-15 14:25 ?4397次閱讀
    ESD<b class='flag-5'>技術(shù)</b><b class='flag-5'>文檔</b>:芯片級ESD與系統(tǒng)級ESD測試標(biāo)準(zhǔn)介紹和差異分析

    簡述電源設(shè)計(jì)經(jīng)驗(yàn)技巧

    在電源設(shè)計(jì)領(lǐng)域中,經(jīng)驗(yàn)的積累往往決定了產(chǎn)品的穩(wěn)定性和可靠性。若是電子新人了解到一些實(shí)用的設(shè)計(jì)技巧,電源設(shè)計(jì)將事半功倍。下面將總結(jié)大佬的14條電源設(shè)計(jì)經(jīng)驗(yàn),以此提供參考和指導(dǎo)。
    的頭像 發(fā)表于 04-23 09:26 ?795次閱讀

    工業(yè)控制PCBA抗震設(shè)計(jì)要點(diǎn):經(jīng)驗(yàn)分享與技術(shù)探討

    工業(yè)控制PCBA的抗震設(shè)計(jì)經(jīng)驗(yàn)分享 在工業(yè)控制領(lǐng)域,PCBA(印制電路板組裝)作為核心組件,其穩(wěn)定性至關(guān)重要。然而,工業(yè)環(huán)境往往伴隨著振動、沖擊等惡劣條件,這對PCBA的抗震性能提出了極高的要求
    的頭像 發(fā)表于 04-14 17:51 ?3600次閱讀

    輔助協(xié)作的簡單原理圖文檔

    電子設(shè)備的原理圖作為PCB設(shè)計(jì)的基礎(chǔ)用于顯示電路圖。除了定義器件和電路之間的電氣連接之外,原理圖還有更深層次的作用:展示理解設(shè)計(jì)所需的文檔。這是一種前端文檔,要充分理解設(shè)計(jì)的核心功能、過去的修訂版
    的頭像 發(fā)表于 04-03 21:32 ?770次閱讀
    輔助協(xié)作的簡單原理圖<b class='flag-5'>文檔</b>

    如何在 樹莓派 上編寫和運(yùn)行 C 語言程序?

    在本教程中,我將討論C編程語言是什么,C編程的用途,以及如何在RaspberryPi上編寫和運(yùn)行C程序。本文的目的是為您介紹在RaspberryPi上進(jìn)行C編程的基礎(chǔ)知識。如果您想深入了解C編程
    的頭像 發(fā)表于 03-25 09:28 ?1066次閱讀
    如何在 樹莓派 上<b class='flag-5'>編寫</b>和運(yùn)行 C 語言程序?

    電源經(jīng)典文檔-精通開關(guān)電源設(shè)計(jì)

    文檔基于作者多年從事開關(guān)電源設(shè)計(jì)的經(jīng)驗(yàn),從分析開關(guān)變換器最基本器件:電感的原理入手,由淺入深系統(tǒng)地論述了寬輸入電壓DC-DC變換器(含離線式正、反激電源)及其磁件設(shè)計(jì)、MOSFET導(dǎo)通和開關(guān)損耗
    發(fā)表于 03-17 14:15

    華企盾:守護(hù)企業(yè)機(jī)密,文檔加密軟件推薦

    了保障信息安全的重要“護(hù)盾”。 2025年,我們應(yīng)關(guān)注哪些文檔加密軟件呢?以下七款軟件在加密領(lǐng)域各具特色,讓我們一起來看看。 一、華企盾DSC數(shù)據(jù)安全系統(tǒng) 核心功能:透明加密技術(shù)讓用戶在處理文檔時幾乎無感,
    的頭像 發(fā)表于 03-10 09:07 ?849次閱讀

    Labview技術(shù)幫助文檔

    Labview最好的教材就是自帶的幫助文檔
    發(fā)表于 03-05 18:01 ?2次下載

    LPDDR4 16Gb 技術(shù)文檔詳解:SK hynix H9HCNNNBKUMLXR 規(guī)格書

    本文詳細(xì)介紹了 SK hynix 公司生產(chǎn)的 LPDDR4 16Gb(x16,2 Channel,1 CS)內(nèi)存芯片 H9HCNNNBKUMLXR 的技術(shù)規(guī)格書。該文檔提供了芯片的詳細(xì)參數(shù)、功能描述
    發(fā)表于 03-03 14:07