Guide
Content Transformation
Discover ways that undocs transforms content to make it more easier to just write documentation.
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 ✅
1
Install Package
Please note that steps only work with numbered lists and is not within children.
npm i undocs2
Run development server
npm run undocs3
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!