Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meqif/docker-compose-mode

Major mode for editing docker-compose files
https://github.com/meqif/docker-compose-mode

docker docker-compose emacs

Last synced: 3 months ago
JSON representation

Major mode for editing docker-compose files

Awesome Lists containing this project

README

        

# docker-compose-mode
[![MELPA](https://melpa.org/packages/docker-compose-mode-badge.svg)](https://melpa.org/#/docker-compose-mode)
[![MELPA Stable](http://stable.melpa.org/packages/docker-compose-mode-badge.svg)](http://stable.melpa.org/#/docker-compose-mode)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Major mode for editing docker-compose files, providing context-aware completion
of docker-compose keys through `completion-at-point-functions`.

The completions can be used with the completion system shipped with vanilla
Emacs, and 3rd-party frontends like company-mode, autocomplete, and
ido-at-point.

## Installation

It's available on [MELPA](https://melpa.org/#/docker-compose-mode):

```
M-x package-install docker-compose-mode
```

Or you can just save the `.el` files in your Emacs' load path.

## Usage

Add the following to your `init.el`:

``` emacs-lisp
(require 'docker-compose-mode)
```

Alternatively, if you prefer using `use-package`:

``` emacs-lisp
(use-package docker-compose-mode)
```

## Customization

By default, the keyword completion function detects the docker-compose version
of the current buffer and suggests the appropriate keywords.

You can change the candidates offered by the backend by customizing `docker-compose-keywords`.