Merge pull request #17 from samk-dev/dev

chore(release): v1.0.1

README.md

@@ -6,19 +6,19 @@
 [![Nuxt][nuxt-src]][nuxt-href]
 [![UIkit][uikit-src]][uikit-href]
 
-Nuxt compatibility: `^3.0.0` Bridge: `false`
-
 ![cover image](.github/assets/nuxt-uikit3.jpg)
 
 UIkit 3 Nuxt module
 
 UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces
 
-- [✨  Release Notes](/nuxt-uikit3/CHANGELOG.md)
-- [UIkit 3 Docs](https://getuikit.com/docs/introduction)
-- [Nuxt Docs](https://nuxt.com/docs/getting-started/introduction)
+Nuxt compatibility: `^3.0.0` Bridge: `false`
+
 - [📖  Documentation](https://nuxt-uikit3-docs.vercel.app)
+- [✨  Release Notes](/nuxt-uikit3/CHANGELOG.md)
 - [🏀 Online playground](https://stackblitz.com/edit/nuxt-uikit3-example?file=app.vue)
+- [📖 UIkit 3 Docs](https://getuikit.com/docs/introduction)
+- [📖 Nuxt Docs](https://nuxt.com/docs/getting-started/introduction)
 
 ## Features
 
@@ -48,7 +48,7 @@ Add `@samk-dev/nuxt-uikit3` to the `modules` section of `nuxt.config.ts`
 ```ts
 export default defineNuxtConfig({
   modules: ['@samk-dev/nuxt-uikit3']
-});
+})
 ```
 
 That's it! You can now use Nuxt Uikit 3 in your Nuxt app ✨
@@ -80,21 +80,12 @@ npm run release -w nuxt-uikit3
 <!-- Badges -->
 
 [npm-version-src]: https://img.shields.io/npm/v/@samk-dev/nuxt-uikit3/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [npm-version-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [npm-downloads-src]: https://img.shields.io/npm/dm/@samk-dev/nuxt-uikit3.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [npm-downloads-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [license-src]: https://img.shields.io/npm/l/@samk-dev/nuxt-uikit3.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [license-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
-
 [nuxt-href]: https://nuxt.com
-
 [uikit-href]: https://getuikit.com
-
 [uikit-src]: .github/assets/uikit-badge.svg

docs/content/0.index.md

@@ -11,13 +11,11 @@ main:
 ::block-hero
 ---
 cta:
-
-- Get started
-- /getting-started/installation
+  - Get started
+  - /getting-started/installation
 secondary:
-- Open on GitHub →
-- https://github.com/samk-dev/nuxt-uikit3
-
+  - Open on GitHub →
+  - https://github.com/samk-dev/nuxt-uikit3
 ---
 
 #title
@@ -27,23 +25,20 @@ Nuxt UIkit 3
 This module helps you set up UIkit Framework in your Nuxt application in seconds
 
 #extra
-::list
-
-- Zero cofig, just plug && play
-- Scss/Less to customize UIkit 3 theme
-- Share your Scss/Less variables && mixins across your nuxt app
-- Use all UIKit 3 JS components without writing any JS
-- Use UIKit 3 default icons pack
-- UIkit 3 documentation in Nuxt Devtools
+  ::list
+  - Zero cofig, just plug && play
+  - Scss/Less to customize UIkit 3 theme
+  - Share your Scss/Less variables && mixins across your nuxt app
+  - Use all UIKit 3 JS components without writing any JS
+  - Use UIKit 3 default icons pack
+  - UIkit 3 documentation in Nuxt Devtools
   ::
 
 #support
-::terminal
+  ::terminal
   ---
-content:
-
-- npm i -D @samk-dev/nuxt-uikit3
-
+  content:
+  - npm i -D @samk-dev/nuxt-uikit3
   ---
-::
+  ::
 ::

docs/content/1.getting-started/2.module-options.md

@@ -18,10 +18,10 @@ export default defineNuxtConfig({
       coreCss: boolean, // default true
       coreTheme: boolean, // default true
       build: {
-        preprocessor: 'string', // 'scss | 'less'
-        stylesPath: 'string',
-        variablesPath: 'string',
-        mixinsPath: 'string'
+        preprocessor: 'scss' | 'less',
+        stylesPath: string,
+        variablesPath: string,
+        mixinsPath: string
       }
     },
     js: boolean, // default true

docs/package.json

@@ -10,7 +10,7 @@
     "lint": "eslint ."
   },
   "devDependencies": {
-    "@nuxt-themes/docus": "^1.12.0",
+    "@nuxt-themes/docus": "^1.12.3",
     "@nuxt/devtools": "^0.5.5",
     "@nuxt/eslint-config": "^0.1.1",
     "@nuxtjs/plausible": "^0.2.1",

nuxt-uikit3/CHANGELOG.md

@@ -1,44 +1,14 @@
 # Changelog
 
-## v1.0.0
+## v1.0.1
 
-### 🚀 Enhancements
+### docs
 
-- Add uikit core css or with uikit default theme css (87b8164)
-- Added support for using custom css preprocessors (3d53f6a)
-- Added support uikit javascript components and icons (133a379)
-- Added support uikit javascript components and icons (e201c3a)
-- Added prerelease script (6b25d02)
-- **dev-deps:** Moved to npm workspaces (c7f669f)
-- Added support for nuxt devtools (eb47dff)
-- Transpile uikit-icons if enabled (0e96d42)
+- fix: landing terminal component
+- improved some parts of the documentation
 
-### 🩹 Fixes
+### chore(dev-deps)
 
-- Module types complaining (9beddeb)
-- Vercel deployment (991d7df)
-
-### 📖 Documentation
-
-- Updated readme.md (9f1aa7a)
-- Added documentation using docus (0e60714)
-- Initial docs ready (2514aa3)
-
-### 🏡 Chore
-
-- Initial commit (3a076a6)
-- Added dependabot (28d06c8)
-- **dev-deps:** Installed @types/uikit (169ba11)
-- **deps-dev:** Bump @types/node from 18.16.16 to 20.2.5 (5801e31)
-- **deps-dev:** Bump @nuxt/module-builder from 0.3.1 to 0.4.0 (e553f50)
-- **prerelease-beta-6:** Prerelease beta 6 (babb220)
-- **pre-release:** Beta.7 (a947f02)
-- Added root tsconfig (d5cb1fb)
-- **dev-deps:** Updated development dependencies (d498e3e)
-- Cleanup before release (20fa727)
-- **version-bump:** Bumped package version (5723438)
-
-### ❤️ Contributors
-
-- Sam K
+- bump: @nuxt to 3.5.3
+- bump: docus to 1.12.3
 

nuxt-uikit3/README.md

@@ -8,15 +8,15 @@ UIkit is a lightweight and modular front-end framework for developing fast and p
 [![Nuxt][nuxt-src]][nuxt-href]
 [![UIkit][uikit-src]][uikit-href]
 
-Nuxt compatibility: `^3.0.0` Bridge: `false`
+![cover image](.github/assets/nuxt-uikit3.jpg)
 
-![cover image](../.github/assets/nuxt-uikit3.jpg)
+Nuxt compatibility: `^3.0.0` Bridge: `false`
 
-- [✨  Release Notes](/nuxt-uikit3/CHANGELOG.md)
-- [UIkit 3 Docs](https://getuikit.com/docs/introduction)
-- [Nuxt Docs](https://nuxt.com/docs/getting-started/introduction)
 - [📖  Documentation](https://nuxt-uikit3-docs.vercel.app)
+- [✨  Release Notes](/nuxt-uikit3/CHANGELOG.md)
 - [🏀 Online playground](https://stackblitz.com/edit/nuxt-uikit3-example?file=app.vue)
+- [📖 UIkit 3 Docs](https://getuikit.com/docs/introduction)
+- [📖 Nuxt Docs](https://nuxt.com/docs/getting-started/introduction)
 
 ## Features
 
@@ -46,53 +46,25 @@ Add `@samk-dev/nuxt-uikit3` to the `modules` section of `nuxt.config.ts`
 ```ts
 export default defineNuxtConfig({
   modules: ['@samk-dev/nuxt-uikit3']
-});
+})
 ```
 
 That's it! You can now use Nuxt Uikit 3 in your Nuxt app ✨
 
-For additional configuration please refer to module docs
-
-## Development
-
-```bash
-# Install dependencies
-npm install
-
-# Generate type stubs
-npm run dev:prepare -w nuxt-uikit3
-
-# Develop with the playground
-npm run dev -w nuxt-uikit3
-
-# Build the playground
-npm run dev:build -w nuxt-uikit3
-
-# Run ESLint
-npm run lint
+For additional configuration please refer to module [docs](https://nuxt-uikit3-docs.vercel.app)
 
-# Release new version
-npm run release -w nuxt-uikit3
 ```
 
 <!-- Badges -->
 
 [npm-version-src]: https://img.shields.io/npm/v/@samk-dev/nuxt-uikit3/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [npm-version-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [npm-downloads-src]: https://img.shields.io/npm/dm/@samk-dev/nuxt-uikit3.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [npm-downloads-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [license-src]: https://img.shields.io/npm/l/@samk-dev/nuxt-uikit3.svg?style=flat&colorA=18181B&colorB=28CF8D
-
 [license-href]: https://npmjs.com/package/@samk-dev/nuxt-uikit3
-
 [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
-
 [nuxt-href]: https://nuxt.com
-
 [uikit-href]: https://getuikit.com
-
 [uikit-src]: .github/assets/uikit-badge.svg
+```

nuxt-uikit3/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@samk-dev/nuxt-uikit3",
   "version": "1.0.0",
+  "homepage": "https://nuxt-uikit3-docs.vercel.app",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -56,7 +57,7 @@
     "@types/uikit": "^3.14.0",
     "changelogen": "^0.5.3",
     "eslint": "^8.41.0",
-    "nuxt": "^3.5.2",
+    "nuxt": "^3.5.3",
     "sass": "^1.62.1",
     "sass-loader": "^13.3.1",
     "vitest": "^0.31.4"