-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add config page to test automd
- Loading branch information
Showing
4 changed files
with
90 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
// @ts-ignore | ||
import $schema from './config.json' | ||
|
||
export default { | ||
$schema, | ||
} |