diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 9fc7266..dd8fc17 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -27,10 +27,10 @@ const baseConfig: UserConfig = { editLink: { pattern: ({ relativePath }): string => { if (relativePath.startsWith('packages/')) { - const [_, pkgName, ...files] = relativePath.split('/'); - return `https://gitlab.com/JKwebGmbH/jktools/-/blob/master/packages/${pkgName}/docs/${files.join('/')}`; + const [, pkgName, ...files] = relativePath.split('/'); + return `https://github.com/teamnovu/kit/tree/main/packages/${pkgName}/docs/${files.join('/')}`; } - return `https://gitlab.com/JKwebGmbH/jktools/-/blob/master/docs/${relativePath}`; + return `https://github.com/teamnovu/kit/tree/main/docs/${relativePath}`; }, }, @@ -38,7 +38,6 @@ const baseConfig: UserConfig = { { text: 'General', items: [ - { text: 'Preparation', link: '/preparation' }, { text: 'Contribute', link: '/contribute' }, { text: 'Guidelines', link: '/guidelines' }, { text: 'Tried and Tested', link: '/tried' }, diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css index 637b240..596ca7c 100644 --- a/.vitepress/theme/style.css +++ b/.vitepress/theme/style.css @@ -8,6 +8,7 @@ * -------------------------------------------------------------------------- */ :root { + --vp-c-bg: #111; --vp-c-brand: #D5C283; --vp-c-brand-1: #D5C283; --vp-c-brand-light: #EBDFB7; diff --git a/README.md b/README.md index a11128c..b0384a4 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,8 @@ Its far from complete and new functionalities are incoming when the need arises. For a list of possible future contributions, take a look at the [Notion page](https://www.notion.so/jkgroup/shared-bits-48e37099b91240acb11dc487e3101068?pvs=4.). -To see the [documentation](https://jktools.storage.googleapis.com/index.html) and contribution guideline please go to https://jktools.storage.googleapis.com/index.html or run: ``` -npm run docs:build -npm run docs:preview +pnpm run docs:build +pnpm run docs:preview ``` diff --git a/docs/preparation.md b/docs/preparation.md deleted file mode 100644 index 20d4ae1..0000000 --- a/docs/preparation.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -outline: deep ---- - -# Preparation - -The jktools is a private repo inside our GitLab. Which means that local environments need access to GitLab, to be able to install it. - -### 1. Generate your GitLab Access Token - -1. Head to GitLab, click your profile, then **Edit Profile**, then, from the sidebar, click on **Access Tokens**. - - [GitLab > Edit profile > Access Tokens](https://gitlab.com/-/profile/personal_access_tokens) - -2. Set the **name** to `JKTOOLS_TOKEN`, and the **scope** to `read_api`. - -3. Copy the generated token. - - -### 2. Setup your local environment - -1. Open the config file for your shell (e.g. `~/.zshrc`). - -2. Export the token: - - ``` - export JKTOOLS_TOKEN= - ``` - -### 3. Update the project - -1. In every project which needs access to jktools, create a file called `.npmrc`, where you may define additional registries (such as the jktools package). - - ``` - @jktools:registry=https://gitlab.com/api/v4/projects/44176668/packages/npm/ - //gitlab.com/api/v4/projects/44176668/packages/npm/:_authToken="${JKTOOLS_TOKEN}" - ``` - -2. Update the `build` section of the `.gitlab.ci.yml` config file to include the token as a build argument, to make sure it's also used when building & deploying the project: - ``` - build: - variables: - BUILD_ARGS: "--build-arg JKTOOLS_TOKEN" - ``` - -3. Optionally, if you use Docker, update `Dockerfile` to include - ``` - ARG JKTOOLS_TOKEN - ``` - - -### 4. You're done 🎉 -You may now install any part of jktools with ` i @teamnovu/kit-PACKAGE`. These instructions will be in every package. diff --git a/package.json b/package.json index 8b03aac..5399e9e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,10 @@ { "description": "One place for shared JS/Web development goods", - "homepage": "https://github.com/teamnovu/kit", + "homepage": "https://kit.novu.ch/", + "repository": { + "type": "git", + "url": "git+ssh://git@github.com:teamnovu/kit.git" + }, "author": "@teamnovu", "type": "module", "packageManager": "pnpm@8.15.3", diff --git a/packages/animations/package.json b/packages/animations/package.json index d400391..8885bc9 100644 --- a/packages/animations/package.json +++ b/packages/animations/package.json @@ -21,7 +21,7 @@ }, "repository": { "type": "git", - "url": "git+ssh://git@gitlab.com/JKwebGmbH/jktools.git" + "url": "git+ssh://git@github.com:teamnovu/kit.git" }, "keywords": [ "composable", @@ -29,10 +29,7 @@ "vue3" ], "author": "Elias Bernhaut", - "bugs": { - "url": "https://gitlab.com/JKwebGmbH/jktools/issues" - }, - "homepage": "https://gitlab.com/JKwebGmbH/jktools#readme", + "homepage": "https://kit.novu.ch/packages/animations/", "dependencies": { "@vueuse/core": "^10.1.0", "nanoid": "^5.0.6" diff --git a/packages/components/package.json b/packages/components/package.json index cd6a679..0574825 100644 --- a/packages/components/package.json +++ b/packages/components/package.json @@ -27,7 +27,7 @@ }, "repository": { "type": "git", - "url": "git+ssh://git@gitlab.com/JKwebGmbH/jktools.git" + "url": "git+ssh://git@github.com:teamnovu/kit.git" }, "keywords": [ "vue", @@ -35,10 +35,7 @@ "components" ], "author": "Elias Bernhaut", - "bugs": { - "url": "https://gitlab.com/JKwebGmbH/jktools/issues" - }, - "homepage": "https://gitlab.com/JKwebGmbH/jktools#readme", + "homepage": "https://kit.novu.ch/packages/components/", "dependencies": { "@teamnovu/kit-composables": "workspace:*", "@vueuse/core": "^9.13.0", diff --git a/packages/composables/package.json b/packages/composables/package.json index 4bb1812..1d420d5 100644 --- a/packages/composables/package.json +++ b/packages/composables/package.json @@ -17,7 +17,7 @@ }, "repository": { "type": "git", - "url": "git+ssh://git@gitlab.com/JKwebGmbH/jktools.git" + "url": "git+ssh://git@github.com:teamnovu/kit.git" }, "keywords": [ "composable", @@ -25,10 +25,7 @@ "vue3" ], "author": "Elias Bernhaut", - "bugs": { - "url": "https://gitlab.com/JKwebGmbH/jktools/issues" - }, - "homepage": "https://gitlab.com/JKwebGmbH/jktools#readme", + "homepage": "https://kit.novu.ch/packages/composables/", "dependencies": { "@vueuse/core": "^9.13.0", "lodash-es": "^4.17.21", diff --git a/packages/cookieconsent/package.json b/packages/cookieconsent/package.json index 249f43d..a6e8b63 100644 --- a/packages/cookieconsent/package.json +++ b/packages/cookieconsent/package.json @@ -19,13 +19,10 @@ }, "repository": { "type": "git", - "url": "git+ssh://git@gitlab.com/JKwebGmbH/jktools.git" + "url": "git+ssh://git@github.com:teamnovu/kit.git" }, "author": "Patrick Stillhart", - "bugs": { - "url": "https://gitlab.com/JKwebGmbH/jktools/issues" - }, - "homepage": "https://gitlab.com/JKwebGmbH/jktools#readme", + "homepage": "https://kit.novu.ch/packages/cookieconsent/", "dependencies": { "@nuxt/kit": "^3.8.1", "@vueuse/core": "^10.5.0", diff --git a/packages/nuxt/docs/index.md b/packages/nuxt/docs/index.md index a013e01..fb4242b 100644 --- a/packages/nuxt/docs/index.md +++ b/packages/nuxt/docs/index.md @@ -1,6 +1,6 @@ # *-nuxt -Add jktools to nuxt +Add @teamnovu/kit-* to nuxt ## Contents diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts index 8998ff9..c3c5665 100644 --- a/packages/nuxt/src/module.ts +++ b/packages/nuxt/src/module.ts @@ -11,26 +11,26 @@ import * as Components from '@teamnovu/kit-components'; import * as Composables from '@teamnovu/kit-composables'; import { type Options as AnimationsOptions } from '@teamnovu/kit-animations'; -export interface JktoolsNuxtOptions { +export interface NovuKitNuxtOptions { prefix?: string animations?: AnimationsOptions } /** - * jktools for Nuxt + * NovuKit for Nuxt * Usage: * * ```ts * // nuxt.config.js * export default { - * modules: ['@vueuse/jktools'] + * modules: ['@teamnovu/kit-nuxt'] * } * ``` */ -const module: NuxtModule = defineNuxtModule({ +const module: NuxtModule = defineNuxtModule({ meta: { - name: 'jktools', - configKey: 'jktools', + name: 'kit', + configKey: 'kit', }, defaults: { prefix: '', @@ -39,7 +39,7 @@ const module: NuxtModule = defineNuxtModule = defineNuxtModule { const runtimeConfig = useRuntimeConfig(); - const config = (runtimeConfig?.public?.jktools.animations ?? {}) as AnimationsOptions; + const config = (runtimeConfig?.public?.kit.animations ?? {}) as AnimationsOptions; vueApp.use(animate, config);