Skip to content

Commit

Permalink
docs: add config page to test automd
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Feb 22, 2024
1 parent 72dd718 commit 0105f4c
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 27 deletions.
25 changes: 0 additions & 25 deletions docs/1.guide/index.md → docs/1.guide/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,3 @@ Start development server:
Build for production:

:pm-run{script="build"}

## Configuration

```json [docs.json]
{
"$schema": "https://raw.githubusercontent.com/unjs/docs/main/schema/config.json",
"name": "packageName",
"description": "packageDescription",
"shortDescription": "packageShortDescription",
"github": "unjs/packageName",
"redirects": {},
"landing": {
"contributors": true,
"heroCode": "",
"heroFeatures": [],
"heroLinks": {},
"features": []
}
}
```

## Components

:read-more{to="/components"}

4 changes: 2 additions & 2 deletions docs/2.components/index.md → docs/1.guide/components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The `<Components>` guide
# Components

> Discover the components you can use in your `markdown` files.
> Discover the components you can use in your markdown files.
## Alerts

Expand Down
82 changes: 82 additions & 0 deletions docs/2.config/1.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Configuration

<!-- automd:jsdocs src="../schema/config.ts" -->

### `$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.

### `dir`

- **Type**: `string`

Documentation directory

Note: This option will be automatically set

### `github`

- **Type**: `string`

The GitHub repository for the documentation site.

### `landing`

- **Type**: `undefined`

### `name`

- **Type**: `string`

The name of the documentation site.

### `redirects`

Redirects for the documentation site.

### `shortDescription`

- **Type**: `string`

The description of the documentation site.

### `themeColor`

- **Type**: `string`

The theme color of the documentation site.
It will be used as the `theme-color` meta tag and a full palette of colors will be generated from it.

### `url`

- **Type**: `string`

The URL of the documentation site.

<!-- /automd -->

<!-- automd:with-automd -->

---

_🤖 auto updated with [automd](https://automd.unjs.io)_

<!-- /automd -->
6 changes: 6 additions & 0 deletions schema/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// @ts-ignore
import $schema from './config.json'

export default {
$schema,
}

0 comments on commit 0105f4c

Please sign in to comment.