Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Initial re-write and re-structuring #17

Merged
merged 1 commit into from
Apr 13, 2015
Merged

feat(docs): Initial re-write and re-structuring #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions app/_assets/stylesheets/base.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ body {
font-family: @family-whitney-ss, @family-default;
color: @font-color;
margin-bottom: 44px;
-webkit-font-smoothing: antialiased;
}

strong {
Expand Down Expand Up @@ -110,11 +111,11 @@ select {
}

code {
padding: 2px 4px;
font-size: 90%;
padding: 4px 6px;
color: #c7254e;
font-size: 14px;
background-color: #f9f2f4;
border-radius: 0;
border-radius: 3px;
border: 0 none;
margin: 0;
}
Expand Down
176 changes: 145 additions & 31 deletions app/_assets/stylesheets/page.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,11 @@
}

.page-navigation {
float: left;
float: right;
width: 230px;
padding: 60px 0;
border-right: 1px solid #ebebeb;
padding: 60px 0 0 20px;

border-left: 1px solid #eee;

@media (max-width: 800px) {
float: none;
Expand All @@ -70,40 +71,41 @@
h5 {
font-family: @family-whitney-ss-sc;
font-size: 13px;
color: #49504e;
font-weight: 500;
color: hsl(204, 8%, 23%);
font-weight: 600;
margin-bottom: 8px;
line-height: 1.6;
text-transform: lowercase;
letter-spacing: 1px;
}

nav > ul {
margin-bottom: 1.5em;
}

li {
line-height: 30px;
line-height: 26px;
}

li ul a {
padding-left: 30px;
color: #9da9b3;
color: #85898c;
}

li a {
padding: 0 17px;
border-left: 1px solid #ebebeb;
padding: 0 15px;

&.active {
font-weight: 500;
cursor: default;
color: #49504e;
background-color: #eef8f2;
border-left: 2px solid @green;
color: hsl(146, 66%, 32%);
}
}

a {
color: hsl(204, 8%, 32%);
font-size: 12px;

&.active,
&:hover {
color: @green;
Expand All @@ -112,21 +114,22 @@
}

.page-content-container {
padding-left: 230px;
padding-right: 230px;

@media (max-width: 800px) {
padding-left: 0;
}
}

.page-content {
padding: 0 50px
padding: 0 50px 0 0;
}

.content {
padding: 60px 0;
font-size: 16px;
font-family: @family-whitney;
font-size: 14px;
font-family: @family-whitney-ss;
font-weight: 500;
line-height: 1.5;

@media (max-width: 800px) {
Expand All @@ -137,38 +140,74 @@
font-size: 23px;
}

p, h1, h2, h3, h4, h5, h6 {
font-family: @family-whitney-ss;
color: #505659;
font-weight: 500;
}

h1, h2, h3 {
margin-bottom: 1em;
font-weight: 600;
}

h1 {
font-size: 34px;
margin-top: 2.5em;
h3, h2 {
font-weight: 600;
color: #262e33;
}

h2 {
font-size: 24px;
border-bottom: 1px solid #ebebeb;
padding-bottom: .5em;
margin-bottom: .5em;
p {
line-height: 25px;
font-size: 14px;
}

h5 {
font-family: @family-whitney-ss-sc;
text-transform: lowercase;
font-size: 13px;
color: hsl(203, 8%, 50%);
letter-spacing: 1px;
font-weight: 600;
line-height: 1.6;
margin-top: 2em;
margin-bottom: 1.5em;
}

h3 {
font-size: 23px;
color: #40805b;
font-weight: 500;
margin-bottom: 0.5em;
line-height:28px;
font-size: 18px;

margin-bottom: .7em;
margin-top: 1.5em;
}

h2 {
line-height:32px;
font-size: 22px;

margin-top: 2em;
margin-bottom: .8em;
}

h1 {
line-height:36px;
font-size: 26px;
color: #262e33;

margin-top: 2em;
margin-bottom: .9em;
}

> h1:first-child,
> h2:first-child,
> h3:first-child {
margin-top: 0px;
}

ol {
list-style: decimal outside;
}

p, figure {
margin-bottom: 1em;
}
Expand All @@ -183,7 +222,9 @@
}

hr {
border-top: 4px solid #ebebeb;
border-top: 2px solid hsl(0, 0%, 92%);
margin-top: 3em;
margin-bottom: 3em;
}

img {
Expand All @@ -204,11 +245,11 @@
}

pre {
background-color: #f2f3f4;
background-color: hsl(210, 8%, 97%);
border: 1px solid #eceeef;
color: #5a6166;
line-height: 24px;
margin: 1em 0;
margin: 1.3em 0;
padding: 8px 13px;
border-radius: 4px;

Expand All @@ -222,6 +263,79 @@
overflow: auto;
}
}

table {
width: 100%;

th, td {
font-family: @family-whitney-ss;
font-size: 13px;
font-weight: 500;
}

th {
font-weight: 600;
text-align: left !important;
}

tr {
td:first-child {
width: 30%;
text-align: right;
}
}
}

.alert {
margin-bottom: 1.3em;
font-size: 14px;

&.alert-warning {
color: hsl(45, 2%, 36%);
border-color: hsl(41, 83%, 89%);
background-color: hsl(51, 100%, 96%);
}

ol {
list-style: decimal inside;
margin-bottom: 0;
margin-top: 1em;

li {
margin-bottom: 0;
}
}
}

.docs-grid {
&:after {
content: " ";
display: block;
clear: left;
}

.docs-grid-block {
float: left;
height: 250px;
width: 50%;

border-bottom: 1px solid #eee;
box-sizing: border-box;

&:nth-child(odd) {
padding: 0 25px 0 0;
}

&:nth-child(even) {
padding: 0 0 0 25px;
}

&:last-of-type {
height: 200px;
border-bottom: none;
}
}
}
}

.instructions-steps {
Expand Down
22 changes: 7 additions & 15 deletions app/_layouts/docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@
<div class="container">
<aside class="page-navigation">
<nav>
<h5><a href="/docs/{{page.kong_version}}/"{% if page.url == "/docs/" %} class="active"{% endif %}>
About</a>
</h5>
<h5>About Kong</h5>
<ul>
<li><a href="/docs/{{page.kong_version}}/about/what"{% if page.url contains "/what/" %} class="active"{% endif %}>What is Kong?</a></li>
<li><a href="/docs/{{page.kong_version}}/about/how"{% if page.url contains "/how/" %} class="active"{% endif %}>How does it work?</a></li>
Expand All @@ -23,8 +21,11 @@ <h5><a href="/docs/{{page.kong_version}}/"{% if page.url == "/docs/" %} class="a
<nav>
<h5>Getting Started</h5>
<ul>
<li><a href="/docs/{{page.kong_version}}/getting-started/installation"{% if page.url contains "/installation/" %} class="active"{% endif %}>Installation</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/configuration"{% if page.url contains "/configuration/" %} class="active"{% endif %}>Configuration</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/introduction"{% if page.url contains "/introduction/" %} class="active"{% endif %}>Introduction</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/quickstart"{% if page.url contains "/quickstart/" %} class="active"{% endif %}>Thirty-second quickstart</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/adding-your-api"{% if page.url contains "/adding-your-api/" %} class="active"{% endif %}>Adding your API</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/enabling-plugins"{% if page.url contains "/enabling-plugins/" %} class="active"{% endif %}>Enabling Plugins</a></li>
<li><a href="/docs/{{page.kong_version}}/getting-started/adding-consumers"{% if page.url contains "/adding-consumers/" %} class="active"{% endif %}>Adding Consumers</a></li>
</ul>
</nav>

Expand All @@ -37,23 +38,14 @@ <h5>Articles</h5>
</ul>
</nav>

<nav>
<h5>Tutorials</h5>
<ul>
<li><a href="/docs/{{page.kong_version}}/tutorials/introduction"{% if page.url contains "/tutorials/introduction" %} class="active"{% endif %}>Introduction</a></li>
<li><a href="/docs/{{page.kong_version}}/tutorials/hello-world"{% if page.url contains "/tutorials/hello-world" %} class="active"{% endif %}>Hello World</a></li>
<li><a href="/docs/{{page.kong_version}}/tutorials/installing-plugin"{% if page.url contains "/tutorials/installing-plugin" %} class="active"{% endif %}>Installing a Plugin</a></li>
</ul>
</nav>

<nav>
<h5>Internal API endpoints</h5>
<ul>
<li><a href="/docs/{{page.kong_version}}/internal-api/">Introduction</a>
<li>
<a href="/docs/{{page.kong_version}}/internal-api/#api-object">API Object</a>
<ul>
<li><a href="/docs/{{page.kong_version}}/internal-api/#create-api">Create API</a></li>
<li><a href="/docs/{{page.kong_version}}/internal-api/#create-api">Add API</a></li>
<li><a href="/docs/{{page.kong_version}}/internal-api/#retrieve-api">Retrieve API</a></li>
<li><a href="/docs/{{page.kong_version}}/internal-api/#list-apis">List APIs</a></li>
<li><a href="/docs/{{page.kong_version}}/internal-api/#delete-api">Delete API</a></li>
Expand Down
Loading