Skip to content

Commit

Permalink
Merge pull request johnsonandjohnson#19 from misterjones/docs/layout-…
Browse files Browse the repository at this point in the history
…review

Minor tweaks and fixes
  • Loading branch information
hvanyo committed Mar 17, 2022
2 parents b8695ee + 852a034 commit feae1ba
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Metadata Component

Bodiless provides a set of HOC's which work with React Helmet
(`[react-helmet](https://github.com/nfl/react-helmet#readme)`) to place editable meta-tags in the
([`react-helmet`](https://github.com/nfl/react-helmet#readme)) to place editable meta-tags in the
document `head`. A Site Builder can find examples of adding editable or non-editable (static)
metadata into the head section from `src/components/Layout/meta.tsx`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ As discussed in other sections, BodilessJS is pre-configured to use
strictly required, we highly recommend it to get the most out of the Bodiless Design System. If you
are unfamiliar with Tailwind, you can learn more from:

- [Tailwind on Github](https://github.com/tailwindcss/tailwindcss)
- [Tailwind Docs](https://tailwindcss.com/docs/what-is-tailwind)
- [Tailwind on GitHub](https://github.com/tailwindcss/tailwindcss)
- [Utility-First Fundamentals | Tailwind Docs](https://tailwindcss.com/docs/utility-first)

Most of your site's styling can be defined with Tailwind, and, for the most part, BodilessJS will
defer to Tailwind documentation. The following documentation is either specific to Bodiless
Expand Down Expand Up @@ -93,7 +93,7 @@ Space](https://devdojo.com/tnylea/tailwindcss-space-classes) | Tony Lea, DevDojo
## Pseudo-Elements

Pseudo-elements are somewhat of a challenge within Tailwind and Bodiless, so please read
[PseudoElements](./PseudoElements) for some recommended patterns for creating pseudo-elements.
[Pseudo-Elements](./Pseudo-Elements) for some recommended patterns for creating pseudo-elements.

## Using Tailwind Classes vs Custom Defined Classes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ one occurrence than to search through files and replace the specific class.
If you want to apply the classes to your entire site, we recommend the following practice:

01. Within `asHelmetToken()`, and in the _Theme_ Domain, provide the site's font class.
<!-- TODO: TBD link to Helmet doc -->
- For more information, see: [CanvasX Helmet
Component](/CX_DesignSystem/Components/CX_Layout/Helmet).

01. In `/cx-layout/src/components/Helmet/Helmet.token.ts`, within `asHelmetToken()`, and in the
_Theme_ Domain, provide the site's font class.
Expand Down
2 changes: 1 addition & 1 deletion packages/cx-elements/doc/CX_Elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ BoldBody: as(
### Using CX Element Tokens, but Customizing for Site-Specific Typography

The Site Builder may need to override a specific token, or a specific set of tokens, and the
following is a how-to guide to apply the [best methodology](./SiteTypography) for doing so.
following is a how-to guide to apply the [best methodology](./CX_SiteTypography) for doing so.

### Helper Utilities

Expand Down
2 changes: 1 addition & 1 deletion packages/cx-layout/doc/Header.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export default Layout;
Provide the Shadowing function as defined in [Shadow](../CX_Elements/CX_Shadow).

File to shadow:
[`cxHeader.ts`](https://github.com/johnsonandjohnson/Bodiless-JS/blob/main/packages/cx-layout/src/components/Header/tokens/cxHeader.ts)
[`cxHeader.ts`](https://github.com/johnsonandjohnson/Bodiless-JS/blob/main/packages/cx-layout/src/components/Header/cxHeader.ts)

#### Customizing Via Extending

Expand Down

0 comments on commit feae1ba

Please sign in to comment.