From fd017a76060d3fd8691d33885d6a0eaea781ea46 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Tue, 30 Jul 2024 11:28:07 -0400 Subject: [PATCH] docs(design): document article encapsulation --- libs/design/article/README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/libs/design/article/README.md b/libs/design/article/README.md index c33bb432e7..294c134844 100644 --- a/libs/design/article/README.md +++ b/libs/design/article/README.md @@ -4,41 +4,47 @@ Article provides styles to common element selectors to create an article in a co ## Overview Article can be used on any content page that displays large blocks of text-driven information. It's meant to be used as a standalone element and should not be nested inside any other components that may change the background color from the anticipated one. In the event that you must nest an article inside another component, please ensure that you set the article's background color to the default body color. -## Headings +## Supported Elements + +### Headings -## Article Meta +### Article Meta Meta is used if there is metadata information about your article (i.e. author name, date, etc). Meta is a custom directive of article and is not a native element selector. To use it, add `daffArticleMeta` to a paragraph (`

`). -## Link +### Link The link style in an article uses the default browser link style. -

Table

+### Table -## Lists +### Lists -### Unordered List +#### Unordered List -### Ordered List +#### Ordered List -## Code +### Code These are styles for inline and multiline blocks of code. -### Inline code +#### Inline code -### Code blocks +#### Code blocks -## Horizontal Rules +### Horizontal Rules -## Blockquote - \ No newline at end of file +### Blockquote + + +## Encapsulation + +Articles also support other custom "non-native" components like [Accordions](../accordion/README.md), [Media Galleries](../media-gallery/README.md), and [Lists](../list/README.md). Unlike typical HTML (

,

    ,