Install

Use npm, pnpm, or yarn. E.g.

pnpm install -D @gitkitjs/gitkitjs

Redistributing gitkitjs as a dependency for redistribution in another npm package is not currently supported - but could be in the future ;-)

package.json

For non-global installs, gitkitjs commands should be added to your package.json scripts E.g.

{
  "name": "my-site",
  "private": true,
  "scripts": {
    "dev": "gitkitjs dev",
    "build": "gitkitjs build"
  },
  "devDependencies": {
    "@gitkitjs/gitkitjs": "^0.5.1"
  }
}

Custom components

There is no need to install or configure SvelteKit, since that is included with gitkitjs.

VS Code

The following VS Code extensions are recommended if you are developing custom components.

• Svelte for VS Code
• Tailwind CSS Intellisense
• Prettier - Code formatter

You can also run Error Lens for faster error reporting, even though it can be a bit niggly.

Tailwind

To use Tailwind VS Code Intellisense while developing custom components, you need Tailwind dependencies in your project, and your own tailwind.config.js in the src directory.

pnpm install -D tailwindcss postcss autoprefixer @tailwindcss/typography

See Custom Tailwind for more details.