Skip to content
Home

Documentation#

The documentation is written in enhanced Markdown, called MDX. It allows us to import other Markdown files along with React components and JavaScript logic.

Handling themes#

If you need to show some documentation only for when a certain theme is selected, you can do so:

<VisibilityByTheme visible="eiendom">


## Eiendom examples


Text


<SpecialExample />


</VisibilityByTheme>

Link to a specific theme#

You can add a parameter called eufemia-theme to a url:

[Relative](/uilib/components/badge/demos/?eufemia-theme=sbanken)
Absolute: https://eufemia.dnb.no/uilib/components/badge/demos/?eufemia-theme=sbanken

It will change and set the currently used theme once the user visits the related page.

Language#

Write the documentation in American English, such as color, behavior, canceled, and customize.

Keep the original spelling in:

  • Release notes and the changelog.
  • URLs, file paths, and public names, such as /uilib/usage/customisation/.
  • Names and titles of external sources.

Translations follow their locale. See Locale support.

Suggest an edit