Contributing

Writing Markdown

Markdown syntax and MDC components available in this portal.

Standard Markdown

All standard Markdown syntax is supported: headings, bold, italic, links, lists, tables, blockquotes, and code blocks.

## Section Title
### Subsection Title

Each heading generates an anchor and appears in the table of contents.

[External link](https://example.com)
[Internal link](/docs/about)

Use fenced code blocks with a language identifier:

```ts
const greeting = 'Hello, Ontopix'
```

You can add a filename label:

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  // ...
})
```

This portal uses MDC (Markdown Components) syntax to embed Vue components in Markdown.

This is an informational note.

::note
This is an informational note.
::

A helpful tip for the reader.

::tip
A helpful tip for the reader.
::

Something to be careful about.

::warning
Something to be careful about.
::

::card-group
  :::card
  ---
  icon: i-lucide-wrench
  title: Engineering
  to: /engineering
  ---
  Engineering handbook documentation.
  :::
::

::tabs
  :::tab{label="npm"}
  npm install my-package
  :::

  :::tab{label="pnpm"}
  pnpm add my-package
  :::
::

::steps
1. First step description
2. Second step description
3. Third step description
::

See the Nuxt UI documentation for the full list of available prose components.

CI/CD Setup for Source Repos

How to configure automatic documentation rebuilds when source repositories change.

Available Collections

Documentation domains currently integrated in this portal.