Skip to content

Commit

Permalink
docs: 📝 Fix some outdated information in readme (#2865)
Browse files Browse the repository at this point in the history
  • Loading branch information
mimarz authored Dec 9, 2024
1 parent 9c86671 commit 2cfd56e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .changeset/grumpy-pianos-lick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@digdir/designsystemet-theme": patch
---

docs: :memo: Fix some outdated information in readme
20 changes: 12 additions & 8 deletions packages/theme/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# @digdir/designsystemet-theme

This package contains the following predefined themes for Designsystemet
This package contains the following predefined Designsystemet themes for use in Digdir.

- `altinn`
- `digdir`
- `tilsynet`
- `brreg`
- `altinn`
- `uutilsynet`
- `portal`

Build your own theme on https://theme.designsystemet.no/

## Usage

When importing the package make sure to specify which brand tokens you want to import. By default the `digdir` is imported if you don't specify a brand.
Read the Designsystemet [README](https://github.com/digdir/designsystemet) to get started.

When importing the package make sure to specify which theme.
By default `digdir` is used.

```tsx
import '@digdir/designsystemet-theme/<brand>.css';
import '@digdir/designsystemet-theme/<theme>.css';

// This imports Digdir brand css tokens
// Digdir theme
import '@digdir/designsystemet-theme';

// This imports Altinn css tokens
// Altinn theme
import '@digdir/designsystemet-theme/altinn.css';
```

Expand All @@ -39,3 +42,4 @@ div {
padding: var(--ds-spacing-1);
}
```

0 comments on commit 2cfd56e

Please sign in to comment.