-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path_component_definition_template.yml
109 lines (95 loc) · 3.11 KB
/
_component_definition_template.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
---
# Core keys to display correctly
layout: component-yaml
section: Components
# Name the component (this is displayed as the title)
title: Inputs
# Status of the component (e.g. experimental, deprecated, etc.)
status: active
# Version (follow the component versioning guide)
version: 1.0.0-beta.1
# List the people involved
people:
- role: Product Owner
name: Joe Macaluso
email: [email protected]
- role: Designer
name: Ed Zee
email: [email protected]
- role: Designer
name: Parker Malenke
email: [email protected]
# Links to any implementations of the component
implementations:
- type: origami
link: https://origami.pearsoned.com/registry/components/o-app-header
# Any downloads available
downloads:
- name: .sketch mockup
link: ./assets/o-app-header.sketch
# Overview information for the component
tagline: |
Brief (one to two line) description
description: |
(optional) More in-depth overview. Markdown is supported
features:
- List out the features
- This is required currently
- A couple major bullets is fine
usage_guidelines: |
Cover when to use the component and any major guidelines. Further details can
be provided below.
# Main contents of the component definition
# `blocks` is a list of the content chunks to display. Several different types
# are currently supported, including:
#
# * section (added to TOC, main header)
# * two column (column of text with images, tables, or code on the right)
# * palette (creates tables for foreground, background, and accent colors)
blocks:
# The section type is added to the TOC and is used to delineate major chunks
# of the article
- type: section
name: Heading Name Goes Here
- type: two column
text: |
Here is the content for the text column on the side. It is run through
markdown.
# (optional) A list of items to put in the right column
contents:
# Images can be wide or narrow, wide images are 760px and narrow are 370px
- type: wide image OR narrow image
src: ./assets/path.to.file.png
caption: (optional), appears below image
# Tables use the markdown format
- type: table
content: |
| Name | Phone | Zip code |
|---------|---------------|-----------|
| Bob | 303-123-4567 | 02134 |
| Sally | 719-432-7869 | 92931 |
# Palettes list colors in a table. All three categories are required, and
# hex values should exclude a preceding '#'.
- type: palette
foreground:
- name: White
hex: FFFFFF
- name: Gray
hex: d8d8d8
background:
- name: Black
hex: 000000
accents:
- name: Blue
hex: 0000ff
# Required. List out each version of the component and the changes made. Make
# sure to follow the component versioning guide.
changelog:
- version: 1.0.0-beta.2
changes: |
- ADDED: Green buttons
- CHANGED: Static links now show an underline which goes away on hover
- version: 1.0.0-beta.1
changes: |
Initial version
---