diff --git a/docs/.config/docs.jsonc b/docs/.config/docs.jsonc deleted file mode 100644 index 194099b..0000000 --- a/docs/.config/docs.jsonc +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "../schema/config.json", - "name": "UnDocs", - "description": "Elegant documentation tooling for UnJS ecosystem.", - "shortDescription": "Docs, made easy.", - "url": "https://undocs.pages.dev", - "github": "unjs/docs", - "redirects": { - "/docs": "/docs/getting-started", - }, - "automd": true, - "landing": { - // "heroLinks": { - // "stackblitz": { "icon": "i-heroicons-play", "to": "https://stackblitz.com/github/unjs/docs/tree/main/template" } - // }, - "contributors": true, - // "featuresLayout": "hero", - "features": [ - { "title": "Eazy to use", "description": "Focus on writing your *documentation* with Markdown, not tooling." }, - { "title": "Nuxt powered", "description": "Made with [Nuxt](https://nuxt.com), Nuxt Content, Nuxt SEO and Nuxt UI Pro." }, - { "title": "Deploy anywhere", "description": "The documentation can be hosted on any static hosting." }, - ], - }, -} diff --git a/docs/.config/docs.yaml b/docs/.config/docs.yaml new file mode 100644 index 0000000..4a5d96a --- /dev/null +++ b/docs/.config/docs.yaml @@ -0,0 +1,25 @@ +# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json + +name: 'UnDocs' +shortDescription: 'Docs, made easy.' +description: 'Elegant documentation tooling for UnJS ecosystem.' +github: 'unjs/docs' +url: 'https://undocs.pages.dev' +redirects: + '/docs': '/docs/getting-started' + '/old': '/docs' +automd: true +landing: + heroLinks: + stackblitz: + icon: 'i-heroicons-play' + to: 'https://stackblitz.com/github/unjs/docs/tree/main/template' + contributors: true + # featuresLayout: 'hero' + features: + - title: 'Eazy to use' + description: 'Focus on writing your *documentation* with Markdown, not tooling.' + - title: 'Nuxt powered' + description: 'Made with [Nuxt](https://nuxt.com), Nuxt Content, Nuxt SEO and Nuxt UI Pro.' + - title: 'Deploy anywhere' + - description: 'The documentation can be hosted on any static hosting.' diff --git a/docs/1.guide/1.index.md b/docs/1.guide/1.index.md index 9beb9a7..4ea7825 100644 --- a/docs/1.guide/1.index.md +++ b/docs/1.guide/1.index.md @@ -1,3 +1,7 @@ +--- +icon: ph:book-open-duotone +--- + # Getting Started > [!IMPORTANT] diff --git a/docs/1.guide/components.md b/docs/1.guide/components.md index b1739ed..ad03025 100644 --- a/docs/1.guide/components.md +++ b/docs/1.guide/components.md @@ -1,3 +1,7 @@ +--- +icon: bxs:component +--- + # Components > Discover the components you can use in your markdown files. diff --git a/docs/2.config/1.index.md b/docs/2.config/1.index.md index 92ba06f..00cd075 100644 --- a/docs/2.config/1.index.md +++ b/docs/2.config/1.index.md @@ -1,5 +1,40 @@ +--- +icon: ri:settings-3-line +--- + # Configuration +## Example + +```yaml +# + + +# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json + +name: 'packageName' +shortDescription: '' +description: '' +github: 'unjs/packageName' +# url: 'https://packageName.unjs.io' +# redirects: +# "/from": "/to" +# automd: true +landing: + heroLinks: + stackblitz: + icon: 'i-heroicons-play' + to: 'https://stackblitz.com/github/unjs/packageName/tree/main/playground' + # contributors: true + # features: + # - title: + # description: + + +``` + +## Reference + ### `$schema` diff --git a/template/.config/docs.yaml b/template/.config/docs.yaml new file mode 100644 index 0000000..8459df0 --- /dev/null +++ b/template/.config/docs.yaml @@ -0,0 +1,19 @@ +# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json + +name: 'packageName' +shortDescription: '' +description: '' +github: 'unjs/packageName' +# url: 'https://packageName.unjs.io' +# redirects: +# "/from": "/to" +# automd: true +landing: + heroLinks: + stackblitz: + icon: 'i-heroicons-play' + to: 'https://stackblitz.com/github/unjs/packageName/tree/main/playground' + # contributors: true + # features: + # - title: + # description: