codewalker/marked
1
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

Add link to demo from readme

Browse Source
This commit is contained in:
Steven 2018-03-25 20:46:27 -04:00
parent 90f1f023bf
commit 239f0aae85
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -7,6 +7,12 @@ Marked is
3. light-weight while implementing all markdown features from the supported flavors & specifications. 3. light-weight while implementing all markdown features from the supported flavors & specifications.
4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects. 4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
## Demo
Checkout the [demo page](https://marked.js.org/demo.html) to see marked in action ⛹️
Our [documentation pages](https://marked.js.org) are also rendered using marked 💯
## Installation ## Installation
**CLI:** `npm install -g marked` **CLI:** `npm install -g marked`
@ -45,8 +51,6 @@ $ cat hello.html
</html> </html>
``` ```
## License ## License
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)

9
docs/README.md
View File

@ -1,5 +1,6 @@
<ul> <ul>
<li><a href="#marked">About</a></li> <li><a href="#marked">About</a></li>
<li><a href="#demo">Demo</a></li>
<li><a href="#installation">Installation</a></li> <li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li> <li><a href="#usage">Usage</a></li>
<li><a href="#specifications">Supported Markdown specifications</a></li> <li><a href="#specifications">Supported Markdown specifications</a></li>
@ -22,6 +23,14 @@ Marked is
<small><sup>**</sup> As few dependencies as possible.</small><br> <small><sup>**</sup> As few dependencies as possible.</small><br>
<small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p> <small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p>
<h2 id="demo">Demo</h2>
Checkout the [demo page](https://marked.js.org/demo.html) to see marked in action ⛹️
These documentation pages are also rendered using marked 💯
<h2 id="installation">Installation</h2> <h2 id="installation">Installation</h2>
**CLI:** `npm install -g marked` **CLI:** `npm install -g marked`