Skip to content

Commit 513a950

Browse files
committed
Tweak main README to point to docs directory
1 parent d94da78 commit 513a950

File tree

2 files changed

+16
-28
lines changed

2 files changed

+16
-28
lines changed

README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
# Drizzle
22

3-
> A pattern library authoring environment
3+
> A streamlined tool for developing, documenting and presenting UI pattern libraries.
44
5-
## Install
5+
## Quick Start
66

77
0. [Download](https://github.com/cloudfour/drizzle/archive/master.zip)
88
0. `npm start`
99

10-
## Overview
10+
## Documentation
1111

12-
Drizzle is a project template and build tool for creating pattern libraries. It outputs static HTML that can live anywhere, using [Gulp], [PostCSS], [Babel], [Webpack] and [Handlebars] under the hood.
12+
- [Getting Started](docs#getting-started)
13+
- [Toolkit Structure](docs#toolkit-structure)
1314

1415
## Inspiration
1516

1617
- https://fbrctr.github.io
1718
- http://solid.buzzfeed.com
1819
- http://patternlab.io
19-
20-
[Gulp]: http://gulpjs.com
21-
[PostCSS]: http://postcss.org
22-
[Babel]: https://babeljs.io
23-
[Webpack]: https://webpack.github.io
24-
[Handlebars]: http://handlebarsjs.com

docs/README.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
[front-matter]: https://github.com/jxson/front-matter
77
[marked]: https://github.com/chjj/marked
88

9-
{{TOC}}
10-
119
# Getting Started
1210

1311
Drizzle is built on the [Node.js](node) platform, so be sure to have it installed before proceeding.
@@ -92,7 +90,7 @@ The templates in this directory differ from [Patterns](#patterns) and [Pages](#p
9290

9391
Files at the top-level of the templates directory are assumed to be layout templates:
9492

95-
| Layout | Usage
93+
| Layout | Usage
9694
| --- | ---
9795
| **default.hbs** | This is for standard pages that do require the presence of the Drizzle UI.
9896
| **blank.hbs** | This is used for special standalone pages that don't require the presence of the Drizzle UI.
@@ -233,10 +231,10 @@ Accessing values can be done with the `{{data}}` template helper. For example:
233231

234232
- name: Pete
235233
photo: pete.jpg
236-
234+
237235
- name: Paul
238236
photo: paul.jpg
239-
237+
240238
- name: Mary
241239
photo: mary.jpg
242240
```
@@ -318,7 +316,7 @@ src/patterns/components/button
318316

319317
These pattern variations would be accessible from other templates as a partials:
320318

321-
```hbs
319+
```hbs
322320
{{> patterns.components.button.base}}
323321
```
324322

@@ -352,7 +350,7 @@ While any arbitrary YAML data can be added, there are some special predefined pr
352350
| **order** | number | This controls the placement relative to neighboring files when the Pattern variations are listed.
353351
| **hidden** | boolean | This hides the Pattern variation from listings, but not from being included as a partial.
354352
| **notes** | string | This is used to provide detailed information about the Pattern variation, and can include [Markdown](marked) formatting.
355-
| **links** | object | This is used to provide a listing of links to additional documentation.
353+
| **links** | object | This is used to provide a listing of links to additional documentation.
356354

357355
Metadata can also be applied to the collections themselves by using a **collection.yaml** file at the root of the directory:
358356

@@ -368,7 +366,7 @@ src/patterns/components/button
368366

369367
Page content files belong in **src/pages**, and can be authored as [Markdown](marked) files, [Handlebars](handlebars) templates, or standard HTML:
370368

371-
Example input:
369+
Example input:
372370

373371
```
374372
src/pages
@@ -378,11 +376,10 @@ src/pages
378376
├── docs
379377
│   ├── example.md
380378
│   └── index.hbs
381-
382379
└── index.hbs
383380
```
384381

385-
Example output:
382+
Example output:
386383

387384
```
388385
dist
@@ -449,14 +446,10 @@ layout: blank
449446

450447
- [ ] **TODO**: Which are supported?
451448

452-
453449
# Acknowledgements
454450

455-
- [ ] **TODO**: Fabricator
456-
- [ ] **TODO**: PatternLab
457-
- [ ] **TODO**: http://solid.buzzfeed.com/
458-
459-
460-
# Contributing
451+
The following projects were inspiration for the design and development of Drizzle:
461452

462-
- [ ] **TODO**: Checkout the repo
453+
- https://fbrctr.github.io
454+
- http://solid.buzzfeed.com
455+
- http://patternlab.io

0 commit comments

Comments
 (0)