Skip to content

Commit 0a1aee8

Browse files
committed
Add docs
1 parent 2ab5889 commit 0a1aee8

File tree

6 files changed

+64
-7
lines changed

6 files changed

+64
-7
lines changed

_includes/header.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
<div class="trigger">
1717
{% for page in site.pages %}
18-
{% if page.title %}
19-
<a class="page-link" href="{{ page.url | prepend: site.baseurl }}">{{ page.title }}</a>
18+
{% if page.menuTitle %}
19+
<a class="page-link" href="{{ page.url | prepend: site.baseurl }}">{{ page.menuTitle }}</a>
2020
{% endif %}
2121
{% endfor %}
2222
</div>

_sass/_base.scss

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,20 +128,25 @@ blockquote {
128128
*/
129129
pre,
130130
code {
131-
font-size: 90%;
131+
font-size: 85%;
132132
border: 1px solid $grey-color-light;
133133
border-radius: 3px;
134134
background-color: #eef;
135135
font-family: $code-font-family;
136136
}
137137

138+
pre code {
139+
background-color: transparent;
140+
}
141+
138142
code {
139143
padding: 2px 5px;
140144
}
141145

142146
pre {
143147
padding: 8px 12px;
144148
overflow-x: scroll;
149+
line-height: 1em;
145150

146151
> code {
147152
border: 0;

_sass/_layout.scss

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,11 @@
197197
margin-bottom: $spacing-unit;
198198
}
199199

200-
.post-title {
200+
h1, .post-title {
201201
font-size: 42px;
202202
letter-spacing: -1px;
203203
line-height: 1;
204+
margin-bottom: $spacing-unit;
204205

205206
@include media-query($on-laptop) {
206207
font-size: 36px;

about.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
layout: page
3-
title: About
3+
title: About Chip
4+
menuTitle: About
45
permalink: /about/
56
---
67

css/main.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ $spacing-unit: 30px;
1515

1616
$text-color: #242B34;
1717
$header-color: #475363;
18-
$background-color: #fdfdfd;
18+
$background-color: #f6f6f6;
1919
$brand-color: #DF8138;
2020

2121
$grey-color: #828282;
22-
$grey-color-light: lighten($grey-color, 40%);
22+
$grey-color-light: lighten($grey-color, 35%);
2323
$grey-color-dark: darken($grey-color, 25%);
2424

2525
// Width of the content area

docs/index.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: page
3+
menuTitle: Docs
4+
title: Chip Documentation
5+
---
6+
7+
## Getting Started
8+
9+
10+
11+
## Many Modules
12+
13+
Chip is made up of many smaller modules. These modules are created such that you could roll your own framework if you
14+
wanted to. But the real benefit is that each module is focused on one specific job.
15+
16+
* **[chip-js](chip-js/)** A powerful JavaScript framework
17+
18+
* **[fragments-js](fragments-js/)** An ultra-fast templating and data-binding library for front-end JavaScript
19+
applications.
20+
21+
* **[observations-js](observations-js/)** Observes simplified JavaScript expressions and triggers callbacks when the
22+
returned value changes.
23+
24+
* **[expressions-js](expressions-js/)** Converts simplified JavaScript expressions into executable functions for
25+
JavaScript frameworks.
26+
27+
* **[differences-js](differences-js/)** Checks if there are any differences between two objects and provides the
28+
difference.
29+
30+
* **[built-ins](built-ins/)** Built in binders, formatters, and animations for fragments.js-based frameworks.
31+
32+
* **[routes-js](routes-js/)** A little standalone routing library, used in chip.js
33+
34+
* **[chip-utils](chip-utils/)** A few basic utilities for use within chip-supported libraries.
35+
36+
```
37+
chip-js
38+
39+
├──fragments-js
40+
│ │
41+
│ └──observations-js
42+
│ │
43+
│ ├──expressions-js
44+
│ │
45+
│ └──differences-js
46+
47+
├──built-ins
48+
49+
└──routes-js
50+
```

0 commit comments

Comments
 (0)