Add navigation to docs
This commit is contained in:
Steven
parent
7f311d761b
commit
ed512a1d0e
@ -1,16 +1,4 @@
|
||||
<ul>
|
||||
<li><a href="#marked">About</a></li>
|
||||
<li><a href="#demo">Demo</a></li>
|
||||
<li><a href="#installation">Installation</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#specifications">Supported Markdown specifications</a></li>
|
||||
<li><a href="#security">Security</a></li>
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#authors">Authors</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="marked">Marked</h2>
|
||||
<h2 id="about">About</h2>
|
||||
|
||||
Marked is
|
||||
|
||||
@ -97,18 +85,3 @@ The only completely secure system is the one that doesn't exist in the first pla
|
||||
|
||||
Therefore, please disclose potential security issues by email to the project [committers](#/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
||||
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
|
||||
The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](#/CONTRIBUTING.md) for more details.
|
||||
|
||||
For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).
|
||||
|
||||
<h2 id="authors">Authors</h2>
|
||||
|
||||
For list of credited authors and contributors, please see our [authors page](#/AUTHORS.md).
|
||||
|
||||
<h2 id="license">License</h2>
|
||||
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
|
||||
See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details.
|
||||
|
||||
101
docs/index.html
101
docs/index.html
@ -9,15 +9,48 @@
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
word-wrap: break-word;
|
||||
background: #F9F9F9;
|
||||
}
|
||||
|
||||
#container {
|
||||
position: relative;
|
||||
max-width: 800px;
|
||||
max-width: 900px;
|
||||
margin: auto;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
#content {
|
||||
padding: 5px 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
background: white;
|
||||
}
|
||||
|
||||
nav {
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
background: white;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
nav > ul {
|
||||
position: sticky;
|
||||
top: 5px;
|
||||
margin: 10px 0px;
|
||||
padding: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
nav > ul > li {
|
||||
min-width: 125px;
|
||||
padding-left: 15px;
|
||||
padding-right: 15px;
|
||||
}
|
||||
|
||||
nav > ul > li > ul {
|
||||
padding-left: 25px;
|
||||
}
|
||||
|
||||
nav > ul > li > ul > li {
|
||||
font-size: 0.8em;
|
||||
}
|
||||
|
||||
header { display: flex; }
|
||||
@ -62,15 +95,18 @@
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.github-ribbon {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
right: 0;
|
||||
border: 0;
|
||||
}
|
||||
.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<a href="https://github.com/markedjs/marked" class="github-corner" aria-label="View source on Github">
|
||||
<svg width="80" height="80" viewBox="0 0 250 250" style="fill:#202020; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
|
||||
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
|
||||
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
|
||||
<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
|
||||
</svg>
|
||||
</a>
|
||||
<div id="container">
|
||||
<header>
|
||||
<a href="#/README.md">
|
||||
@ -78,16 +114,47 @@
|
||||
</a>
|
||||
<h1>Marked.js Documentation</h1>
|
||||
</header>
|
||||
<div style="display: flex">
|
||||
<nav>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#/README.md">Getting Started</a>
|
||||
<ul>
|
||||
<li><a href="#/README.md#marked">About</a></li>
|
||||
<li><a href="#/README.md#demo">Demo</a></li>
|
||||
<li><a href="#/README.md#installation">Installation</a></li>
|
||||
<li><a href="#/README.md#usage">Usage</a></li>
|
||||
<li><a href="#/README.md#specifications">Specs</a></li>
|
||||
<li><a href="#/README.md#security">Security</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#/USING_ADVANCED.md">Advanced Usage</a>
|
||||
<ul>
|
||||
<li><a href="#/USING_ADVANCED.md#the-marked-function">Function</a></li>
|
||||
<li><a href="#/USING_ADVANCED.md#options">Options</a></li>
|
||||
<li><a href="#/USING_ADVANCED.md#highlight">Highlighting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#/USING_PRO.md">Extensibility</a>
|
||||
<ul>
|
||||
<li><a href="#/USING_PRO.md#renderer">Renderer</a></li>
|
||||
<li><a href="#/USING_PRO.md#lexer">Lexer</a></li>
|
||||
<li><a href="#/USING_PRO.md#parser">Parser</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#/CONTRIBUTING.md">Contributing</a></li>
|
||||
<li><a href="#/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
|
||||
<li><a href="#/AUTHORS.md">Authors</a></li>
|
||||
<li><a href="#/PUBLISHING.md">Publishing</a></li>
|
||||
|
||||
<a href="https://github.com/markedjs/marked">
|
||||
<img class="github-ribbon" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
|
||||
</a>
|
||||
|
||||
<div id="content"></div>
|
||||
</ul>
|
||||
</nav>
|
||||
<div id="content"></div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/unfetch/dist/unfetch.umd.js"></script>
|
||||
<script src="../lib/marked.js"></script>
|
||||
<script>
|
||||
if (!window.Promise) {
|
||||
window.Promise = ES6Promise;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user