Installation
For the complete documentation index, see llms.txt. Prefer markdown by appending .md to documentation URLs or sending Accept: text/markdown.

Editor setup

Configure your Edge Kit editor with Oxc and Tailwind extensions, apply the repository's formatting settings, and get type-aware feedback while coding.

Of course, you can use any IDE you like, but you'll have the best possible developer experience with this starter kit when using a VSCode-based editor with the suggested settings and extensions.

Settings

We've included the recommended settings in the .vscode/settings.json file. They wire up Oxfmt and Oxlint to run on save and hide the generated route tree from search and watchers. You can adjust them to your needs.

.vscode/settings.json
{
  "oxc.fmt.configPath": "oxfmt.config.ts",
  "editor.defaultFormatter": "oxc.oxc-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.oxc": "always"
  },
  "editor.formatOnSave": true
  ...
}

Extensions

Once you've cloned the project and opened it in VSCode, you should be prompted to install the suggested extensions, which are defined in .vscode/extensions.json. If you'd rather install them manually, you can do so at any time.

OXC

Global extension for static code analysis. It formats with Oxfmt and reports problems from Oxlint, including real TypeScript errors, because the lint config is type-aware. It's compatible with Prettier and ESLint.

Download Oxc

marketplace.visualstudio.com

Tailwind CSS IntelliSense

Autocomplete, syntax highlighting, and linting for Tailwind CSS classes. Class sorting is handled by Oxfmt on save.

Download Tailwind CSS IntelliSense

marketplace.visualstudio.com

Other editors

Oxc has plugins for Zed, Neovim, JetBrains IDEs, and more. Point the formatter at oxfmt.config.ts and you get the same results.

Follow the coding conventions for imports, server modules, and translated copy. If you use an AI coding assistant, configure the shipped agent rules and skills too. The common commands show how to run the same checks outside your editor.

How is this guide?

Last updated on

On this page

Ship globally on the edge. In minutes.Try Edge Kit