From ed512a1d0e1edeca57898de240d0d88d2e178bdc Mon Sep 17 00:00:00 2001 From: Steven Date: Fri, 3 Aug 2018 16:16:37 -0400 Subject: [PATCH 1/8] Add navigation to docs --- docs/README.md | 29 +------------- docs/index.html | 103 +++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 86 insertions(+), 46 deletions(-) diff --git a/docs/README.md b/docs/README.md index f41160ce9f..974178c2c3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,16 +1,4 @@ - - -

Marked

+

About

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). -

Contributing

- -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). - -

Authors

- -For list of credited authors and contributors, please see our [authors page](#/AUTHORS.md). - -

License

- -Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) - -See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details. diff --git a/docs/index.html b/docs/index.html index a985d16f5e..76633964e9 100644 --- a/docs/index.html +++ b/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}} + + + +
@@ -78,16 +114,47 @@

Marked.js Documentation

- - - Fork me on GitHub - - -
+
+ +
+
- - - + + + + - +