markdown文檔

Usage

歡迎使用 Markdown在線編輯器 MdEditor

Markdown是一種輕量級的「標記語言」javascript

markdown

Markdown是一種可使用普通文本編輯器編寫的標記語言,經過簡單的標記語法,它可使普通文本內容具備必定的格式。它容許人們使用易讀易寫的純文本格式編寫文檔,而後轉換成格式豐富的HTML頁面,Markdown文件的後綴名即是「.md」php

MdEditor是一個在線編輯Markdown文檔的編輯器

MdEditor擴展了Markdown的功能(如表格、腳註、內嵌HTML等等),以使讓Markdown轉換成更多的格式,和更豐富的展現效果,這些功能原初的Markdown尚不具有。css

Markdown加強版中比較有名的有Markdown Extra、MultiMarkdown、 Maruku等。這些衍生版本要麼基於工具,如Pandoc,Pandao;要麼基於網站,如GitHub和Wikipedia,在語法上基本兼容,但在一些語法和渲染效果上有改動。html

MdEditor源於Pandao的JavaScript開源項目,開源地址Editor.md,並在MIT開源協議的許可範圍內進行了優化,以適應廣大用戶羣體的需求。向優秀的markdown開源編輯器原做者Pandao致敬。java

Pandao editor.md

MdEditor的功能列表演示

# 標題H1

## 標題H2

### 標題H3

#### 標題H4

##### 標題H5

###### 標題H5

字符效果和橫線等


刪除線 刪除線(開啓識別HTML標籤時)python

斜體字 斜體字linux

粗體 粗體git

粗斜體 粗斜體github

上標:X2,下標:O2算法

縮寫(同HTML的abbr標籤)

即更長的單詞或短語的縮寫形式,前提是開啓識別HTML標籤時,已默認開啓

The HTML specification is maintained by the W3C.

引用 Blockquotes

引用文本 Blockquotes

引用的行內混合 Blockquotes

引用:若是想要插入空白換行即<br />標籤,在插入處先鍵入兩個以上的空格而後回車便可,普通連接

普通連接
普通連接帶標題
直接連接:https://www.mdeditor.com
[錨點連接][anchor-id]
[anchor-id]: https://www.mdeditor.com/
mailto:test.test@gmail.com
GFM a-tail link @pandao
郵箱地址自動連接 test.test@gmail.com www@vip.qq.com

@pandao

多語言代碼高亮 Codes

行內代碼 Inline code

執行命令:npm install marked

縮進風格

即縮進四個空格,也作爲實現相似 <pre> 預格式化文本 ( Preformatted Text ) 的功能。

<?php
    echo "Hello world!";
?>

預格式化文本:

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

JS代碼

function test() {
    console.log("Hello world!");
}

HTML 代碼 HTML codes

<!DOCTYPE html>
<html>
    <head>
        <mate charest="utf-8" />
        <meta name="keywords" content="Editor.md, Markdown, Editor" />
        <title>Hello world!</title>
        <style type="text/css">
            body{font-size:14px;color:#444;font-family: "Microsoft Yahei", Tahoma, "Hiragino Sans GB", Arial;background:#fff;}
            ul{list-style: none;}
            img{border:none;vertical-align: middle;}
        </style>
    </head>
    <body>
        <h1 class="text-xxl">Hello world!</h1>
        <p class="text-green">Plain text</p>
    </body>
</html>

圖片 Images

圖片加連接 (Image + Link):

Follow your heart.


列表 Lists

無序列表(減號)Unordered Lists (-)

  • 列表一
  • 列表二
  • 列表三

無序列表(星號)Unordered Lists (*)

  • 列表一
  • 列表二
  • 列表三

無序列表(加號和嵌套)Unordered Lists (+)

  • 列表一
  • 列表二
    • 列表二-1
    • 列表二-2
    • 列表二-3
  • 列表三
    • 列表一
    • 列表二
    • 列表三

有序列表 Ordered Lists (-)

  1. 第一行
  2. 第二行
  3. 第三行

GFM task list

  • [x] GFM task list 1
  • [x] GFM task list 2
  • [ ] GFM task list 3
    • [ ] GFM task list 3-1
    • [ ] GFM task list 3-2
    • [ ] GFM task list 3-3
  • [ ] GFM task list 4
    • [ ] GFM task list 4-1
    • [ ] GFM task list 4-2

繪製表格 Tables

項目 價格 數量
計算機 $1600 5
手機 $12 12
管線 $1 234
First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
Function name Description
help() Display the help window.
destroy() Destroy your computer!
Left-Aligned Center Aligned Right Aligned
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1
Item Value
Computer $1600
Phone $12
Pipe $1

特殊符號 HTML Entities Codes

© & ¨ ™ ¡ £
& < > ¥ € ® ± ¶ § ¦ ¯ « ·

X² Y³ ¾ ¼ × ÷ »

18ºC " '

[========]

Emoji表情 😃

Blockquotes ⭐

GFM task lists & Emoji & fontAwesome icon emoji & editormd logo emoji :editormd-logo-5x:

  • [x] 😃 @mentions, 😃 #refs, links, formatting, and tags supported :editormd-logo:;
  • [x] list syntax required (any unordered or ordered list supported) :editormd-logo-3x:;
  • [x] [ ] 😃 this is a complete item 😃;
  • [ ] []this is an incomplete item test link :fa-star: @pandao;
  • [ ] [ ]this is an incomplete item :fa-star: :fa-gear:;
    • [ ] 😃 this is an incomplete item test link :fa-star: :fa-gear:;
    • [ ] 😃 this is :fa-star: :fa-gear: an incomplete item test link;

反斜槓 Escape

*literal asterisks*

[========]

科學公式 TeX(KaTeX)

\[E=mc^2\]

行內的公式\[E=mc^2\]行內的公式,行內的\[E=mc^2\]公式。

\[x > y\]

\[\(\sqrt{3x-1}+(1+x)^2\)\]

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

多行公式:

\displaystyle
\left( \sum\_{k=1}^n a\_k b\_k \right)^2
\leq
\left( \sum\_{k=1}^n a\_k^2 \right)
\left( \sum\_{k=1}^n b\_k^2 \right)
\displaystyle
    \frac{1}{
        \Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{
        \frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {
        1+\frac{e^{-6\pi}}
        {1+\frac{e^{-8\pi}}
         {1+\cdots} }
        }
    }
f(x) = \int_{-\infty}^\infty
    \hat f(\xi)\,e^{2 \pi i \xi x}
    \,d\xi

分頁符 Page break

Print Test: Ctrl + P

[========]

繪製流程圖 Flowchart

st=>start: 用戶登錄
op=>operation: 登錄操做
cond=>condition: 登錄成功 Yes or No?
e=>end: 進入後臺

st->op->cond
cond(yes)->e
cond(no)->op

[========]

繪製序列圖 Sequence Diagram

Andrew->China: Says Hello
Note right of China: China thinks\nabout it
China-->Andrew: How are you?
Andrew->>China: I am good thanks!

End

歡迎使用 Cmd Markdown 編輯閱讀器


咱們理解您須要更便捷更高效的工具記錄思想,整理筆記、知識,並將其中承載的價值傳播給他人,Cmd Markdown 是咱們給出的答案 —— 咱們爲記錄思想和分享知識提供更專業的工具。 您可使用 Cmd Markdown:

  • 整理知識,學習筆記
  • 發佈日記,雜文,所見所想
  • 撰寫發佈技術文稿(代碼支持)
  • 撰寫發佈學術論文(LaTeX 公式支持)

cmd-markdown-logo

除了您如今看到的這個 Cmd Markdown 在線版本,您還能夠前往如下網址下載:

Windows/Mac/Linux 全平臺客戶端

請保留此份 Cmd Markdown 的歡迎稿兼使用說明,如需撰寫新稿件,點擊頂部工具欄右側的 新文稿 或者使用快捷鍵 Ctrl+Alt+N


什麼是 Markdown

Markdown 是一種方便記憶、書寫的純文本標記語言,用戶可使用這些標記符號以最小的輸入代價生成極富表現力的文檔:譬如您正在閱讀的這份文檔。它使用簡單的符號標記不一樣的標題,分割不一樣的段落,粗體 或者 斜體 某些文字,更棒的是,它還能夠

1. 製做一份待辦事宜 Todo 列表

  • [ ] 支持以 PDF 格式導出文稿
  • [ ] 改進 Cmd 渲染算法,使用局部渲染技術提升渲染效率
  • [x] 新增 Todo 列表功能
  • [x] 修復 LaTex 公式渲染問題
  • [x] 新增 LaTex 公式編號功能

2. 書寫一個質能守恆公式1

\[E=mc^2\]

3. 高亮一段代碼2

@requires_authorization
class SomeClass:
    pass

if __name__ == '__main__':
    # A comment
    print 'hello world'

4. 高效繪製 流程圖

st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes)->e
cond(no)->op

5. 高效繪製 序列圖

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

6. 高效繪製 甘特圖

title 項目開發流程
    section 項目肯定
        需求分析       :a1, 2016-06-22, 3d
        可行性報告     :after a1, 5d
        概念驗證       : 5d
    section 項目實施
        概要設計      :2016-07-05  , 5d
        詳細設計      :2016-07-08, 10d
        編碼          :2016-07-15, 10d
        測試          :2016-07-22, 5d
    section 發佈驗收
        發佈: 2d
        驗收: 3d

7. 繪製表格

項目 價格 數量
計算機 $1600 5
手機 $12 12
管線 $1 234

8. 更詳細語法說明

想要查看更詳細的語法說明,能夠參考咱們準備的 Cmd Markdown 簡明語法手冊,進階用戶能夠參考 Cmd Markdown 高階語法手冊 瞭解更多高級功能。

總而言之,不一樣於其它 所見即所得 的編輯器:你只需使用鍵盤專一於書寫文本內容,就能夠生成印刷級的排版格式,省卻在鍵盤和工具欄之間來回切換,調整內容和格式的麻煩。Markdown 在流暢的書寫和印刷級的閱讀體驗之間找到了平衡。 目前它已經成爲世界上最大的技術分享網站 GitHub 和 技術問答網站 StackOverFlow 的御用書寫格式。


什麼是 Cmd Markdown

您可使用不少工具書寫 Markdown,可是 Cmd Markdown 是這個星球上咱們已知的、最好的 Markdown 工具——沒有之一 :)由於深信文字的力量,因此咱們和你同樣,對流暢書寫,分享思想和知識,以及閱讀體驗有極致的追求,咱們把對於這些訴求的迴應整合在 Cmd Markdown,而且一次,兩次,三次,乃至無數次地提高這個工具的體驗,最終將它演化成一個 編輯/發佈/閱讀 Markdown 的在線平臺——您能夠在任何地方,任何系統/設備上管理這裏的文字。

1. 實時同步預覽

咱們將 Cmd Markdown 的主界面一分爲二,左邊爲編輯區,右邊爲預覽區,在編輯區的操做會實時地渲染到預覽區方便查看最終的版面效果,而且若是你在其中一個區拖動滾動條,咱們有一個巧妙的算法把另外一個區的滾動條同步到等價的位置,超酷!

2. 編輯工具欄

也許您仍是一個 Markdown 語法的新手,在您徹底熟悉它以前,咱們在 編輯區 的頂部放置了一個以下圖所示的工具欄,您可使用鼠標在工具欄上調整格式,不過咱們仍舊鼓勵你使用鍵盤標記格式,提升書寫的流暢度。

tool-editor

3. 編輯模式

徹底心無旁騖的方式編輯文字:點擊 編輯工具欄 最右側的拉伸按鈕或者按下 Ctrl + M,將 Cmd Markdown 切換到獨立的編輯模式,這是一個極度簡潔的寫做環境,全部可能會引發分心的元素都已經被挪除,超清爽!

4. 實時的雲端文稿

爲了保障數據安全,Cmd Markdown 會將您每一次擊鍵的內容保存至雲端,同時在 編輯工具欄 的最右側提示 已保存 的字樣。無需擔憂瀏覽器崩潰,機器掉電或者地震,海嘯——在編輯的過程當中隨時關閉瀏覽器或者機器,下一次回到 Cmd Markdown 的時候繼續寫做。

5. 離線模式

在網絡環境不穩定的狀況下記錄文字同樣很安全!在您寫做的時候,若是電腦忽然失去網絡鏈接,Cmd Markdown 會智能切換至離線模式,將您後續鍵入的文字保存在本地,直到網絡恢復再將他們傳送至雲端,即便在網絡恢復前關閉瀏覽器或者電腦,同樣沒有問題,等到下次開啓 Cmd Markdown 的時候,她會提醒您將離線保存的文字傳送至雲端。簡而言之,咱們盡最大的努力保障您文字的安全。

6. 管理工具欄

爲了便於管理您的文稿,在 預覽區 的頂部放置了以下所示的 管理工具欄

tool-manager

經過管理工具欄能夠:

發佈:將當前的文稿生成固定連接,在網絡上發佈,分享
新建:開始撰寫一篇新的文稿
刪除:刪除當前的文稿
導出:將當前的文稿轉化爲 Markdown 文本或者 Html 格式,並導出到本地
列表:全部新增和過往的文稿均可以在這裏查看、操做
模式:切換 普通/Vim/Emacs 編輯模式

7. 閱讀工具欄

tool-manager

經過 預覽區 右上角的 閱讀工具欄,能夠查看當前文稿的目錄並加強閱讀體驗。

工具欄上的五個圖標依次爲:

目錄:快速導航當前文稿的目錄結構以跳轉到感興趣的段落
視圖:互換左邊編輯區和右邊預覽區的位置
主題:內置了黑白兩種模式的主題,試試 黑色主題,超炫!
閱讀:心無旁騖的閱讀模式提供超一流的閱讀體驗
全屏:簡潔,簡潔,再簡潔,一個徹底沉浸式的寫做和閱讀環境

8. 閱讀模式

閱讀工具欄 點擊 或者按下 Ctrl+Alt+M 隨即進入獨立的閱讀模式界面,咱們在版面渲染上的每個細節:字體,字號,行間距,前背景色都傾注了大量的時間,努力提高閱讀的體驗和品質。

9. 標籤、分類和搜索

在編輯區任意行首位置輸入如下格式的文字能夠標籤當前文檔:

標籤: 未分類

標籤之後的文稿在【文件列表】(Ctrl+Alt+F)裏會按照標籤分類,用戶能夠同時使用鍵盤或者鼠標瀏覽查看,或者在【文件列表】的搜索文本框內搜索標題關鍵字過濾文稿,以下圖所示:

file-list

10. 文稿發佈和分享

在您使用 Cmd Markdown 記錄,創做,整理,閱讀文稿的同時,咱們不只但願它是一個有力的工具,更但願您的思想和知識經過這個平臺,連同優質的閱讀體驗,將他們分享給有相同志趣的人,進而鼓勵更多的人來到這裏記錄分享他們的思想和知識,嘗試點擊 (Ctrl+Alt+P) 發佈這份文檔給好友吧!


再一次感謝您花費時間閱讀這份歡迎稿,點擊 (Ctrl+Alt+N) 開始撰寫新的文稿吧!祝您在這裏記錄、閱讀、分享愉快!

做者 @ghosert
2016 年 07月 07日


  1. 支持 LaTeX 編輯顯示支持,例如:\(\sum_{i=1}^n a_i=0\), 訪問 MathJax 參考更多使用方法。

  2. 代碼高亮功能支持包括 Java, Python, JavaScript 在內的,四十一種主流編程語言。

相關文章
相關標籤/搜索