mirror of
https://github.com/showdownjs/showdown.git
synced 2024-03-22 13:30:55 +08:00
87 lines
3.4 KiB
HTML
87 lines
3.4 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta charset='utf-8'>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||
|
|
<meta name="description" content="Showdown : A JavaScript markdown converter. Extensible. Truthful.">
|
||
|
|
|
||
|
|
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
|
||
|
|
|
||
|
|
<title>Showdown</title>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<!-- HEADER -->
|
||
|
|
<div id="header_wrap" class="outer">
|
||
|
|
<header class="inner">
|
||
|
|
<a id="forkme_banner" href="https://github.com/showdownjs/showdown">View on GitHub</a>
|
||
|
|
|
||
|
|
<h1 id="project_title">Showdown</h1>
|
||
|
|
<h2 id="project_tagline">A JavaScript markdown converter. Extensible. Truthful.</h2>
|
||
|
|
|
||
|
|
<section id="downloads">
|
||
|
|
<a class="zip_download_link" href="https://github.com/showdownjs/showdown/zipball/master">Download this project as a .zip file</a>
|
||
|
|
<a class="tar_download_link" href="https://github.com/showdownjs/showdown/tarball/master">Download this project as a tar.gz file</a>
|
||
|
|
</section>
|
||
|
|
</header>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- MAIN CONTENT -->
|
||
|
|
<div id="main_content_wrap" class="outer">
|
||
|
|
<section id="main_content" class="inner">
|
||
|
|
<p><strong>Showdown</strong> is a markdown parser and html converter with an attempt to stay <a href="https://github.com/showdownjs/showdown/wiki/divergences">as close as possible</a> to the <a href="http://web.archive.org/web/20110111145019/http://attacklab.net/showdown/">original</a>, while providing extensibility through a simple yet efficient <a href="https://github.com/showdownjs/showdown/wiki/extensions">plugin</a> facility. Tables, GitHub flavoured, and what not.</p>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<a id="get-it" class="anchor" href="#get-it" aria-hidden="true"><span class="octicon octicon-link"></span></a>Get It</h2>
|
||
|
|
|
||
|
|
<pre><code>npm install showdown
|
||
|
|
# or
|
||
|
|
bower install showdown
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<a id="use-it" class="anchor" href="#use-it" aria-hidden="true"><span class="octicon octicon-link"></span></a>Use It</h2>
|
||
|
|
|
||
|
|
<pre><code>var Showdown = require('showdown');
|
||
|
|
var converter = new Showdown.converter();
|
||
|
|
|
||
|
|
converter.makeHtml('#hello markdown!');
|
||
|
|
|
||
|
|
// <h1 id="hellomarkdown">hello markdown!</h1>
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<a id="need-help" class="anchor" href="#need-help" aria-hidden="true"><span class="octicon octicon-link"></span></a>Need Help?</h2>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://github.com/showdownjs/showdown/wiki">Wiki</a></li>
|
||
|
|
<li><a href="https://groups.google.com/forum/#!forum/showdownjs">Google Group</a></li>
|
||
|
|
<li><a href="https://github.com/showdownjs/showdown/issues">Issues</a></li>
|
||
|
|
<li><a href="http://stackoverflow.com/questions/tagged/showdown">stackoverflow</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h2>
|
||
|
|
<a id="credits" class="anchor" href="#credits" aria-hidden="true"><span class="octicon octicon-link"></span></a>Credits</h2>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="http://web.archive.org/web/20110111145019/http://attacklab.net/showdown/">Showdown Copyright (c) 2007 John Fraser</a></li>
|
||
|
|
<li><a href="http://daringfireball.net/projects/markdown/">Original Markdown Copyright (c) 2004-2005 John Gruber</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- FOOTER -->
|
||
|
|
<div id="footer_wrap" class="outer">
|
||
|
|
<footer class="inner">
|
||
|
|
<p class="copyright">Showdown maintained by <a href="https://github.com/showdownjs">showdownjs</a></p>
|
||
|
|
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|