showdown下載 - showdown源代碼下載

showdown

其他源碼

2.1.0

下載

攤牌是基於約翰·格魯伯（John Gruber）的原始作品的HTML轉換器的JavaScript標記。攤牌可以使用客戶端（在瀏覽器中）或服務器端（帶有node.js）。

現場演示

在此處查看現場演示：http：//demo.showdownjs.com/

如您所知，Showdownjs是一個免費的庫，它將永遠保持自由。但是，維護和改進圖書館花費時間和金錢。

如果您喜歡我們的作品並發現我們的圖書館有用，請通過PayPal捐款！您的貢獻將不勝感激，並幫助我繼續開發這個很棒的圖書館。

執照

Showdownjs V 2.0根據MIT許可發布。以前的版本以BSD發布。

誰使用攤牌（或叉子）

GoogleCloudPlatform
流星
stackexchange-分叉為pagedown
托克
MD頁
qcobjects
還有其他一些...

安裝

下載tarball

您可以直接從發行版中下載最新版本的Tarball。

鮑爾

 bower install showdown

NPM（服務器端）

 npm install showdown

Nuget軟件包

 PM> Install-Package showdownjs

Nuget軟件包可以在此處找到。

CDN

您還可以使用可用的幾個CDN之一：

jsdelivr

  https://cdn.jsdelivr.net/npm/showdown@<version tag>/dist/showdown.min.js

CDNJS

  https://cdnjs.cloudflare.com/ajax/libs/showdown/<version tag>/showdown.min.js

UNPKG

  https://unpkg.com/showdown/dist/showdown.min.js

注意：用您對Eg 1.9.0感興趣的實際全長版本替換<version tag>

瀏覽器兼容性

攤牌已成功測試：

Firefox 1.5和2.0
Chrome 12.0
Internet Explorer 6和7
Safari 2.0.4
歌劇8.54和9.10
Netscape 8.1.2
Konqueror 3.5.4

從理論上講，攤牌將在任何支持ECMA 262第三版（JavaScript 1.5）的瀏覽器中起作用。轉換器本身甚至可能在不是網絡瀏覽器的事物中工作，例如Acrobat。沒有保證。

節點兼容性

攤牌旨在在任何受支持的node.js版本上使用（請參閱node.js發行時間表。代碼可以與node.js的先前版本一起使用，但沒有做出任何貼心以確保它的功能。

舊版本

如果您正在尋找攤牌v <1.0.0，則可以在傳統分支中找到它。

ChangElog

您可以檢查完整的更改程序

擴展文檔

檢查我們的Wiki頁面以獲取示例和更深入的文檔。

快速示例

節點

 var showdown  = require ( 'showdown' ) ,
    converter = new showdown . Converter ( ) ,
    text      = '# hello, markdown!' ,
    html      = converter . makeHtml ( text ) ;

瀏覽器

 var converter = new showdown . Converter ( ) ,
    text      = '# hello, markdown!' ,
    html      = converter . makeHtml ( text ) ;

輸出

兩個示例都應輸出...

    < h1 id =" hellomarkdown " > hello, markdown! </ h1 >

選項

您可以通過選項更改Showdown的一些默認行為。

設置選項

可以設置選項：

全球

設置“全局”選項會影響攤牌的所有實例

 showdown . setOption ( 'optionKey' , 'value' ) ;

本地

設置“本地”選項僅影響指定的轉換器對象。可以設置本地選項：

通過構造函數

 var converter = new showdown . Converter ( { optionKey : 'value' } ) ;

通過setOption（）方法

 var converter = new showdown . Converter ( ) ;
converter . setOption ( 'optionKey' , 'value' ) ;

獲得選項

攤牌提供2種方法（本地和全局）來檢索先前的集合選項。

getOption（）

 // Global
var myOption = showdown . getOption ( 'optionKey' ) ;

//Local
var myOption = converter . getOption ( 'optionKey' ) ;

getOptions（）

 // Global
var showdownGlobalOptions = showdown . getOptions ( ) ;

//Local
var thisConverterSpecificOptions = converter . getOptions ( ) ;

檢索默認選項

您可以使用以下方式獲得攤牌的默認選項

 var defaultOptions = showdown . getDefaultOptions ( ) ;

有效的選項

OmitextrawlIncodeBlocks ：（ boolean）[默認錯誤]省略了代碼塊中的尾隨newline。前任：

這：

 < code > < pre > var foo = 'bar';
</ pre > </ code >

變成了：

 < code > < pre > var foo = 'bar'; </ pre > </ code >

Noheaderid ：（布爾值）[默認錯誤]禁用自動生成標題ID。設置為TRUE覆蓋Prefixheaderid
CustomizedHeaderId ：（布爾值）[默認錯誤]將捲曲括號中的文本用作標頭ID。 （既然v1.7.0）示例：
```
 ## Sample header {real-id}     will use real-id as id
```
ghcompatibleheaderid ：（ boolean）[默認false]生成與github樣式兼容的標頭ID（空間被破折號替換，並刪除了一堆非字母數字字符） （因為v1.5.5）
prefixheaderid ：（ string/boolean）[默認錯誤]在生成的標頭ID中添加前綴。傳遞字符串將前綴該字符串到標題ID。設置為true將添加通用的“部分”前綴。
RAWPREFIXHEADERID ：（ boolean）[默認錯誤]將此選項設置為true將阻止攤牌修改前綴。這可能會導致畸形的ID（例如，如果“前綴中使用char”。
RAWHEADERID ：（ boolean）[默認錯誤]僅刪除空格，並且“從生成的標頭ID（包括前綴）中，用dashes（ - ）。警告：這可能會導致畸形ID （因為v1.7.3）
headerLevelStart ：（ integer）[默認1]設置標題啟動級別。例如，將此設置為3表示
```
 # foo
```
將被解析為
```
 < h3 > foo </ h3 >
```

parseimgdimensions ：（ boolean）[默認錯誤]啟用了從Markdown語法中設置圖像尺寸的支持。示例：

 ![foo](foo.jpg =100x80)     simple, assumes units are in px
![bar](bar.jpg =100x*)      sets the height to "auto"
![baz](baz.jpg =80%x5em)  Image with width of 80% and height of 5em

SimplifiedAutolink ：（ boolean）[默認錯誤]打開此選項將啟用自動鏈接到URL。這意味著：
```
some text www.google.com
```
將被解析為
```
 < p > some text < a href =" www.google.com " > www.google.com </ a >
```
DefkudetrailingPunctuationFromurls ：（ boolean）[默認錯誤]此選項將尾隨標點符號排除在自動鏈接URL中。標點符號不包括： . ! ? ( ) 。僅當簡化的autolink選項設置為true時才適用。
literalmidwordunderscores ：（ boolean）[默認錯誤]打開此操作將停止攤牌，從單詞中間解釋為<em>和<strong> ，而是將它們視為字面的下劃線。
例子：
```
some text with __ underscores __ in middle
```
將被解析為
```
 < p > some text with__underscores__in middle </ p >
```
lintalmidwordasterisks ：（布爾值）[默認錯誤]打開此操作將停止攤牌，從單詞中間解釋為<em>和<strong> ，而是將它們視為字面的星號。
罷工：（布爾）[默認錯誤]啟用對罷工語法的支持。 ~~strikethrough~~ AS <del>strikethrough</del>

表：（布爾值）[默認錯誤]啟用對錶語法的支持。例子：

 | h1    |    h2   |      h3 |
| :------ | :-------: | --------: |
| 100   | [ a ] [ 1 ]  | ![ b ] [ 2 ] |
| * foo * | ** bar ** | ~~ baz ~~ |

有關更多信息，請參見Wiki

tableSheaderId ：（ boolean）[默認錯誤]如果啟用啟用將ID屬性添加到表標頭標籤。
ghcodeblocks ：（布爾值）[默認為true]啟用對GFM代碼塊樣式的支持。
任務列表：（布爾值）[默認錯誤]啟用對GFM任務清單的支持。例子：
```
 - [x] This task is done
 - [ ] This is still pending
```
SmoothlivePreview ：（ boolean）[默認錯誤]由於輸入不完整而導致實時預覽中的奇怪效果
smartIndentationFix ：（ boolean）[默認錯誤]試圖在縮進代碼中智能解決與ES6模板字符串有關的凹痕問題。
disableforced4spaceSindentedSublists ：（ boolean）[默認錯誤]禁用了將訂閱者縮進4個空間以嵌套的訂閱者的要求，從而有效地恢復到2或3個空間足夠的舊行為。 （由於v1.5.0）
SimpleLineBreaks ：（ boolean）[默認錯誤]解析行的斷裂如<br> ，而無需在行末端需要2個空間（自v1.5.1）
```
a line  
wrapped in two
```
變成：
```
 < p > a line < br >
wrapped in two </ p >
```
需要spaceBeforeheadText ：（ boolean）[默認錯誤]使#和標題文本強制性之間添加一個空間（因為v1.5.3）
ghmentions ：（布爾值）[默認錯誤]啟用github @entrions，鏈接到所述用戶名（自v1.6.0）
GhmentionsLink ：（String）[默認https://github.com/{u} ]更改@Mentions生成的鏈接。攤牌將用用戶名替換{u} 。僅在啟用Ghmentions選項時適用。示例： @tivie with ghmentionsoption設置為//mysite.com/{u}/profile將導致<a href="//mysite.com/tivie/profile">@tivie</a>
encodeemails ：（ boolean）[默認為true]啟用電子郵件地址通過使用字符實體編碼，將ASCII電子郵件地址轉換為其等效小數實體。（由於v1.6.1）
注意：在版本1.6.1之前，電子郵件將始終通過DEC和十六進制編碼來混淆。
OpenLinkSinNewwindow ：（ boolean）[默認false]打開新Windows中的所有鏈接（通過將屬性target="_blank"添加到<a>標籤中） （因為v1.7.0）
backslashescapeshtmltags ：（ boolean）[默認false]支持HTML標籤逃脫。例如： <div>foo</div> （由於v1.7.2）
表情符號：（布爾值）[默認錯誤]啟用表情符號支持。例如： this is a :smile: emoji有關可用表情符號的更多信息，請參見https：//github.com/showdownjs/showdown/wiki/emojis （自v.1.8.0起）
下劃線：（布爾值）[默認錯誤]實驗功能可以支持下劃線。語法是雙重或三重下指數： __underlined word__ 。啟用了此選項，下劃線不再分析<em>和<strong> 。
省略號：（布爾值）[默認為true]將三個點替換為省略號的unicode字符。
完整的Htmldocument ：（ boolean）[默認錯誤]輸出一個完整的HTML文檔，包括<html> ， <head>和<body>標籤，而不是HTML片段。（自v.1.8.5以來

元數據：（布爾值）[默認錯誤]啟用對文檔元數據的支持（定義在««« and »»»之間或---和 - 和--- ）之間的文檔頂部。（自v.1.8.5以來

 var conv = new showdown . Converter ( { metadata : true } ) ;
var html = conv . makeHtml ( someMd ) ;
var metadata = conv . getMetadata ( ) ; // returns an object with the document metadata

SplitAdjacentBlockQuotes ：（boolean）[默認錯誤]拆分相鄰的塊塊塊。（自v.1.8.6）
Morestyling ：（布爾值）[默認錯誤]為CSS樣式添加了一些有用的類。（由於v2.0.1）
- 任務列表：將類task-list-item-complete添加到GFM任務列表中的完成任務項目中。

注意：請注意，在版本1.6.0之前，所有這些選項默認情況下在CLI工具中被禁用。

口味

您還可以使用口味或預設自動設置正確的選項，因此攤牌的行為就像流行的Markdown口味一樣。

目前，可用以下口味：

原始 - 原始的賣風味，如約翰·格魯伯（John Gruber）的規格
香草 - 攤牌基礎風味（如v1.3.1）
github -GFM（github調味的降價）

全球的

 showdown . setFlavor ( 'github' ) ;

實例

 converter . setFlavor ( 'github' ) ;

CLI工具

攤牌還與命令行接口工具捆綁在一起。您可以檢查CLI Wiki頁面以獲取更多信息

與Angularjs集成

Showdownjs項目還通過“插件”與AngularJS無縫集成。請訪問https://github.com/showdownjs/ngshowdown了解更多信息。

與打字稿集成

如果您正在使用Typescript

與SystemJS/JSPM集成

與SystemJS集成可以通過第三方“ System-MD”插件獲得。

與Vuejs集成

要快速使用Showdownjs作為VUE組件，您可以檢查Vue-showdown。

XSS漏洞

攤牌不會消毒輸入。這是通過設計，因為Markdown依靠它允許將某些功能正確解析為HTML。但是，這意味著XSS注入非常有可能。

請參閱Wiki文章Markdown的XSS漏洞（以及如何減輕它）以獲取更多信息。

擴展

攤牌允許通過擴展加載其他功能。（您可以在此處找到已知攤牌擴展名的列表）您還可以找到一個樣板，以在此存儲庫中創建自己的擴展名

客戶端擴展使用情況

 < script src = "showdown.js" / >
< script src = "twitter-extension.js" / >

var converter = new showdown . Converter ( { extensions : [ 'twitter' ] } ) ;

服務器端擴展使用情況

 var showdown    = require ( 'showdown' ) ,
    myExtension = require ( 'myExtension' ) ,
    converter = new showdown . Converter ( { extensions : [ 'myExtension' ] } ) ;

建築

構建存儲庫的克隆很容易。

預先Quesite：Node.js V12，NPM和NPX必須安裝。

運行npm install 。
運行npx grunt build （請參閱Gruntfile.js ）。此命令：
1. 清潔倉庫。
2. 檢查代碼質量（Jshint和Eslint）。
3. 運行測試。
4. 在dist文件夾中創建可分佈和縮小的文件。

測試

有一套需要node.js的測試套件。安裝節點後，將以下命令從項目root運行以安裝依賴項：

 npm install

一旦安裝，可以使用：

 npm test

可以輕鬆添加新的測試用例。創建一個Markdown文件（以.md結尾），其中包含要測試的標記。創建一個完全相同的名稱的.html文件。當使用mocha執行測試時，它將自動測試。

貢獻

如果您想貢獻，請閱讀以下快速指南。

想要功能嗎？

您可以通過提交問題請求新功能。如果您想實現新功能，請隨時發出拉動請求。

拉請求（PRS）

PR很棒。但是，在提交拉動請求之前，請考慮以下準則：

搜索github查看與您的提交有關的打開或封閉請求請求。您不想重複努力。
發出更改代碼的PR時，請根據開發在新的GIT分支中進行更改：
```
git checkout -b my-fix-branch develop
```
在提交之前運行完整的測試套件並確保所有測試通過（顯然= P）。
嘗試遵循我們的編碼樣式規則。打破它們可以防止PR通過測試。
避免在同一拉的請求中解決多個問題。最好打開多個小PR，而不是很難審查大型PR。
如果PR引入新功能或解決問題，請添加適當的測試用例。
我們使用常規的提交註釋來生成遵循常規ChangElog規格的更改程序。如果您的提交消息遵守這些提交指南，這將非常有幫助。
不要忘記將您的名稱添加到Credits.md文件中。我們喜歡給予信用。
如果我們建議更改，那麼：
- 進行所需的更新。
- 重新運行測試套件以確保測試仍在通過。
- 將您的分支重新置於您的GitHub存儲庫（這將更新您的拉請請求）：
```
git rebase develop -i
git push origin my-fix-branch -f
```
合併拉動請求後，您可以安全地刪除分支。