6
6
[ front-matter ] : https://github.com/jxson/front-matter
7
7
[ marked ] : https://github.com/chjj/marked
8
8
9
- {{TOC}}
10
-
11
9
# Getting Started
12
10
13
11
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
92
90
93
91
Files at the top-level of the templates directory are assumed to be layout templates:
94
92
95
- | Layout | Usage
93
+ | Layout | Usage
96
94
| --- | ---
97
95
| ** default.hbs** | This is for standard pages that do require the presence of the Drizzle UI.
98
96
| ** 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:
233
231
234
232
- name : Pete
235
233
photo : pete.jpg
236
-
234
+
237
235
- name : Paul
238
236
photo : paul.jpg
239
-
237
+
240
238
- name : Mary
241
239
photo : mary.jpg
242
240
` ` `
@@ -318,7 +316,7 @@ src/patterns/components/button
318
316
319
317
These pattern variations would be accessible from other templates as a partials :
320
318
321
- ` ` ` hbs
319
+ ` ` ` hbs
322
320
{{> patterns.components.button.base}}
323
321
` ` `
324
322
@@ -352,7 +350,7 @@ While any arbitrary YAML data can be added, there are some special predefined pr
352
350
| **order** | number | This controls the placement relative to neighboring files when the Pattern variations are listed.
353
351
| **hidden** | boolean | This hides the Pattern variation from listings, but not from being included as a partial.
354
352
| **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.
356
354
357
355
Metadata can also be applied to the collections themselves by using a **collection.yaml** file at the root of the directory :
358
356
@@ -368,7 +366,7 @@ src/patterns/components/button
368
366
369
367
Page content files belong in **src/pages**, and can be authored as [Markdown](marked) files, [Handlebars](handlebars) templates, or standard HTML :
370
368
371
- Example input :
369
+ Example input :
372
370
373
371
` ` `
374
372
src/pages
@@ -378,11 +376,10 @@ src/pages
378
376
├── docs
379
377
│ ├── example.md
380
378
│ └── index.hbs
381
-
382
379
└── index.hbs
383
380
` ` `
384
381
385
- Example output :
382
+ Example output :
386
383
387
384
` ` `
388
385
dist
@@ -449,14 +446,10 @@ layout: blank
449
446
450
447
- [ ] **TODO** : Which are supported?
451
448
452
-
453
449
# Acknowledgements
454
450
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 :
461
452
462
- - [ ] **TODO** : Checkout the repo
453
+ - https://fbrctr.github.io
454
+ - http://solid.buzzfeed.com
455
+ - http://patternlab.io
0 commit comments