Files
vim-astro/README.md
2023-10-20 23:02:07 -06:00

69 lines
2.0 KiB
Markdown

# Astro support for Vim or Neovim
> 🧑‍🚀 Not sure what Astro is? See their website at [astro.build](https://astro.build)!
Provides syntax highlighting and indentation support for `.astro` files.
<div align="center">
<img src="https://raw.githubusercontent.com/wuelnerdotexe/vim-astro/main/assets/vim-astro.png">
<strong>Theme:</strong> <a href="https://wuelnerdotexe.github.io/enfocado">Enfocado</a> Dark Neon.
</div>
## Features
- Syntax highlighting for embedded languages:
- JavaScript and JSX.
- TypeScript and TSX.
- CSS, SCSS, SASS, and LESS.
- Stylus (need external support).
- Indentation (experimental).
- Code folding.
- No dependencies from external syntax plugins.
- Full integration with Vim functions. [Read more](https://github.com/wuelnerdotexe/vim-astro/pull/3).
## Installation
Install via your preferred package manager. Example using [vim-plug](https://github.com/junegunn/vim-plug):
```vim
Plug 'wuelnerdotexe/vim-astro'
```
alternatively, install manually.
## Configuration
The following variables control certain syntax highlighting features. You can add them to your `.vimrc` or `init.vim`.
```vim
let g:astro_typescript = 'enable'
```
Enables TypeScript and TSX for `.astro` files.
Default Value: 'disable'
```vim
let g:astro_stylus = 'enable'
```
Enables Stylus for `.astro` files.
Default Value: 'disable'
NOTE: Vim does not provide Stylus support by default, but you can install [vim-stylus](https://github.com/wavded/vim-stylus) to support it.
## Maintainer
> Hi 👋, I'm **[Wuelner](https://linktr.ee/wuelnerdotexe)**, a **software developer from Guatemala**, passionate about creating minimalist solutions using solid fundamentals focused on **"how things should be"**.
## Credits
- Based on: Plugin [vim-svelte](https://github.com/evanleck/vim-svelte) by. [Evan Lecklider's](https://github.com/evanleck).
## License
[MIT &copy; Wuelner Martínez.](https://github.com/wuelnerdotexe/vim-astro/blob/main/LICENSE)
<p align="center">With 💖 from <strong>LATAM</strong> to the world!</p>