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

Jump to bottom

feat(docs): Update blockquotes usage page #1969

Merged
merged 2 commits into from
Mar 30, 2021
Merged

feat(docs): Update blockquotes usage page #1969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ea00de
feat(docs): Update blockquotes usage page
Yaomimi Mar 30, 2021
81ec4d0
docs(blockquote): Fixes with prettier
planctus Mar 30, 2021
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
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@
"ini": "^1.3.6",
"lodash": "^4.17.19",
"node-fetch": "^2.6.1",
"serialize-javascript": "^3.1.0"
"serialize-javascript": "^3.1.0",
"y18n": "^5.0.5"
},
"engines": {
"node": ">=8.15.1",
Expand Down
15 changes: 9 additions & 6 deletions src/website/src/pages/ec/components/blockquote/docs/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ order: 1
import { Paragraph, Anatomy } from '@ecl/website-components';

<Paragraph size="lead">
The Block Quote component is used when citing any source.
The blockquotes component is used to capture users' attention of an excerpt,
testimonial, or a quote cited from the article or other sources. The design
style makes the quoted section more distinguishable than the rest of the
content in the web page.
</Paragraph>

## Anatomy
Expand Down Expand Up @@ -36,17 +39,17 @@ import { Paragraph, Anatomy } from '@ecl/website-components';

## Do's

- always name the source
- limit the quote to one paragraph
- always name the source of the quoted content
- limit the quote to one paragraph, keep it short

## Don'ts

- do not add rich text formatting (such as images, videos, etc)
- do not apply the blockquotes components more than 2 times in a webpage

## When to use

- always use when quoting a source
- for quoting something important

## When not to use

- do not use to simply emphasise text
- for the purpose of emphasising text style
7 changes: 1 addition & 6 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23719,12 +23719,7 @@ xtend@^4.0.0, xtend@^4.0.1, xtend@~4.0.0, xtend@~4.0.1:
resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54"
integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==

"y18n@^3.2.1 || ^4.0.0", y18n@^4.0.0:
version "4.0.0"
resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.0.tgz#95ef94f85ecc81d007c264e190a120f0a3c8566b"
integrity sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==

y18n@^5.0.5:
"y18n@^3.2.1 || ^4.0.0", y18n@^4.0.0, y18n@^5.0.5:
version "5.0.5"
resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.5.tgz#8769ec08d03b1ea2df2500acef561743bbb9ab18"
integrity sha512-hsRUr4FFrvhhRH12wOdfs38Gy7k2FFzB9qgN9v3aLykRq0dRcdcpz5C9FxdS2NuhOrI/628b/KSTJ3rwHysYSg==
Expand Down