| title | description | i18nReady |
|---|---|---|
Editor Setup |
Set up your editor to build with Astro. |
true |
import PackageManagerTabs from '/components/tabs/PackageManagerTabs.astro'
import Badge from "/components/Badge.astro"
Customize your code editor to improve the Astro developer experience and unlock new features.
VS Code is a popular code editor for web developers, built by Microsoft. The VS Code engine also powers popular in-browser code editors like GitHub Codespaces and Gitpod.
Astro works with any code editor. However, VS Code is our recommended editor for Astro projects. We maintain an official Astro VS Code Extension that unlocks several key features and developer experience improvements for Astro projects.
- Syntax highlighting for
.astrofiles. - TypeScript type information for
.astrofiles. - VS Code Intellisense for code completion, hints and more.
To get started, install the Astro VS Code Extension today.
import ReadMore from '~/components/ReadMore.astro';
See how to set up TypeScript in your Astro project.
Zed is an open-source code editor that added support for Astro in version 0.123.2. You can install the Astro extension in the IDE's Extensions tab. This extension includes features like syntax highlighting, code completion, and formatting.
Initial support for Astro landed in WebStorm 2023.1. You can install the official plugin through JetBrains Marketplace or by searching for "Astro" in the IDE's Plugins tab. This plugin includes features like syntax highlighting, code completion, and formatting, and plans to add even more advanced features in the future. It is also available to all other JetBrains IDEs with JavaScript support.
Our amazing community maintains several extensions for other popular editors, including:
- VS Code Extension on Open VSX - The official Astro VS Code Extension, available on the Open VSX registry for open platforms like VSCodium
- Nova Extension - Provides syntax highlighting and code completion for Astro inside of Nova
- Vim Plugin - Provides syntax highlighting, indentation, and code folding support for Astro inside of Vim or Neovim
- Neovim LSP and TreeSitter Plugins - Provides syntax highlighting, treesitter parsing, and code completion for Astro inside of Neovim
- Emacs - See instructions for Configuring Emacs and Eglot to work with Astro
- Astro syntax highlighting for Sublime Text - The Astro package for Sublime Text, available on the Sublime Text package manager.
In addition to local editors, Astro also runs well on in-browser hosted editors, including:
- StackBlitz and CodeSandbox - online editors that run in your browser, with built-in syntax highlighting support for
.astrofiles. No installation or configuration required! - GitHub.dev - allows you to install the Astro VS Code extension as a web extension, which gives you access to only some of the full extension features. Currently, only syntax highlighting is supported.
- Gitpod - a full dev environment in the cloud that can install the official Astro VS Code Extension from Open VSX.
ESLint is a popular linter for JavaScript and JSX. For Astro support, a community maintained plugin can be installed.
See the project's User Guide for more information on how to install and set up ESLint for your project.
Stylelint is a popular linter for CSS. A community maintained Stylelint configuration provides Astro support.
Installation instructions, editor integration, and additional information can be found in the project's README.
Prettier is a popular formatter for JavaScript, HTML, CSS, and more. If you're using the Astro VS Code Extension or the Astro language server within another editor, code formatting with Prettier is included.
To add support for formatting .astro files outside of the editor (e.g. CLI) or inside editors that don't support our editor tooling, install the official Astro Prettier plugin.
To get started, first install Prettier and the plugin:
```shell npm install --save-dev prettier prettier-plugin-astro ``` ```shell pnpm add -D prettier prettier-plugin-astro ``` ```shell yarn add --dev prettier prettier-plugin-astro ```Prettier will then automatically detect the plugin and use it to process .astro files when you run it:
prettier --write .See the Prettier plugin's README for more information about its supported options, how to set up Prettier inside VS Code, and more.