Skip to content

Commit

Permalink
docs: Add preliminary info on how to partial
Browse files Browse the repository at this point in the history
  • Loading branch information
hidde committed Nov 8, 2023
1 parent 22c4213 commit 5f46190
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/richtlijnen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,42 @@ In het NL Design System verzamelen we documentatie vanuit de community. Dit kan

Deze documentatie wordt regelmatig bijgewerkt.

## Gebruik van partials

We gebruiken zoveel mogelijk ‘partials’: stukjes content die los zouden kunnen gebruikt, bijvoorbeeld in een ander design system, worden als partial opgeslagen (bij ons een Markdown-bestand dat met `_` begint) en dan geïmporteerd.

Voorbeeld, waarin op een pagina over fruit de informatie over appels, peren en bananen in aparte bestanden staat en geïmporteerd wordt:

```mdx
import Apple from "./_apple.md";
import Pear from "./_pear.md";
import Banana from "./_banana.md";

# Fruits

<Apple />
<Pear />
<Banana />
```

### Namen voor partials

We willen de namen liefst niet meer veranderen, en dus toekomstbestendig maken (vanuit de ‘cool URI's don't change’ gedachte).

Enkele richtlijnen:

- gebruik enkelvoud tenzij meervoud noodzakelijk is
- gebruik keywords uit HTML/CSS/SVG voor IDs/slugs/filenames
- gebruik prefixes en hiërarchie in prefixes zodat door sorteren automatisch groepjes ontstaan

Voorbeelden van namen voor label-gerelateerde partials:

```
_label-position.md
_label-text.md
_label-visibility.md
_label-no-activate.md
_label-text-visibility.md
```

<!-- TODO! -->

0 comments on commit 5f46190

Please sign in to comment.