Content Transformation

Undocs is currently intended for UnJS docs only and is not fully customizable yet.
Contributions are more than welcome but please consider that this project is not ready yet to be used.
Make sure to use Bun and WSL for Windows. We don't guarantee stability yet and it is expected that it doesn't work time to time.

Github Notes

https://github.com/orgs/community/discussions/16925

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Negative potential consequences of an action.

Auto Code Groups

If you have code blocks right after each other, they will be grouped together using code-group.

    ```ts [nuxt.config.ts]
    export default defineNuxtConfig({
      modules: [],
    })
    ```

    ```ts [server/api/hello.get.ts]
    export default defineEventHandler(() => {
      return {
        hello: 'world'
      }
    })
    ```

    ```vue [app.vue]
    <template>
      <div>
      <h1>Welcome to the homepage</h1>
      </div>
    </template>
    ```

export default defineNuxtConfig({
  modules: [],
})

Steps

Generate steps by useing standard markdown numbered lists!

In order to generate this component, you need to have content inside at least one of the lists. The list can't be a child of another component & also any content within a Mardown list will need at least 2 tabs to be considered as a child of the list.

1. Install Package

   ::note
   Please note that steps only work with numbered lists and is not within children.
   ::

   :pm-install{name="undocs"}

2. Run development server

   :pm-run{script="undocs"}

3. Done ✅

Install Package

Please note that steps only work with numbered lists and is not within children.

npm i undocs

Run development server

npm run undocs

Done ✅

Config References

Generate beautiful references for your configuration files by just using markdown!

If you use automd:jsdocs, you can reference the schema file directly! Check out this example from the config page.

  ### `$schema`

  - **Type**: `string`

  ### `automd`

  - **Type**: `boolean`

  Enable integration with https://automd.unjs.io

  ### `buildCache`

  - **Type**: `boolean`

  Enable build cache (experimental)

  ### `description`

  - **Type**: `string`

  The description of the documentation site.

$schema

string

automd

boolean

Enable integration with https://automd.unjs.io

buildCache

boolean

Enable build cache (experimental)

description

string

The description of the documentation site.

Do you have an idea for a new content transformation, feel free to open an issue!

Edit this page on GitHub

Components

Discover the components you can use in your markdown files.

Configuration