Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhysd/vim-github-actions
(Outdated) Vim syntax/indent support for GitHub Actions *.workflow files
https://github.com/rhysd/vim-github-actions
github-actions syntax-highlighting vim vim-filetype vim-indent vim-plugin
Last synced: 7 days ago
JSON representation
(Outdated) Vim syntax/indent support for GitHub Actions *.workflow files
- Host: GitHub
- URL: https://github.com/rhysd/vim-github-actions
- Owner: rhysd
- License: mit
- Created: 2018-11-04T09:46:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-15T11:40:48.000Z (almost 6 years ago)
- Last Synced: 2024-11-01T11:51:29.311Z (14 days ago)
- Topics: github-actions, syntax-highlighting, vim, vim-filetype, vim-indent, vim-plugin
- Language: Vim script
- Homepage:
- Size: 6.84 KB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Vim filetype support for [GitHub Actions][gha]
==============================================
This is a Vim filetype support for [GitHub Actions][gha].
It provides:
- Highlighting `.github/*.workflow` files.
- It only highlights keywords described in [official document][workflow-doc]. You can easily notice wrong attribute names.
- Indentation for `.github/*.workflow` files.
## Installation
If you use any package manager, please follow its instruction.
With [vim-plug](https://github.com/junegunn/vim-plug):
```vim
Plug 'rhysd/vim-github-actions'
```
With [dein.vim](https://github.com/Shougo/dein.vim):
```vim
call dein#add('rhysd/vim-github-actions')
```
With [minpac](https://github.com/k-takata/minpac):
```vim
call minpac#add('rhysd/vim-github-actions')
```
When you're using Vim's builtin packager, please follow instruction at `:help pack-add`.
## Usage
After this plugin is loaded, highlights and indentation are automatically applied. You have nothing
to do anymore.
Please confirm that `ghaworkflow` filetype is set when you open `.github/*.workflow` files.
## Links
- [GitHub Actions][gha]
- [About GitHub Actions](https://developer.github.com/actions/)
- [Creating workflows](https://developer.github.com/actions/creating-workflows/)
- [Creating a workflow with GitHub Actions](https://help.github.com/articles/creating-a-workflow-with-github-actions/)
- [Workflow configuration options](https://developer.github.com/actions/creating-workflows/workflow-configuration-options/)
## License
[MIT License](License.txt)
[gha]: https://github.com/features/actions
[workflow-doc]: https://developer.github.com/actions/creating-workflows/workflow-configuration-options/