Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lifeart/els-addon-docs

Ember Language Server Addon Docs Completion Provider
https://github.com/lifeart/els-addon-docs

els-addon ember-addon ember-language-server emberjs

Last synced: about 1 month ago
JSON representation

Ember Language Server Addon Docs Completion Provider

Host: GitHub
URL: https://github.com/lifeart/els-addon-docs
Owner: lifeart
Created: 2019-12-03T23:26:47.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2022-12-10T11:18:39.000Z (almost 2 years ago)
Last Synced: 2024-10-09T18:41:46.167Z (about 1 month ago)
Topics: els-addon, ember-addon, ember-language-server, emberjs
Language: JavaScript
Homepage:
Size: 1.17 MB
Stars: 8
Watchers: 5
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # els-addon-docs

Ember Language Server Addon Docs Completion Provider

How to use?

Install this addon as `dev-dependency` inside your ember project.

### Component information

![Component information](previews/component-information.png)

### Argument information

![Argument information](previews/argument-information.png)

### Block params autocomplete

![Block params autocomplete](previews/block-params-autocomplete.png)

### Yielded values autocomplete

![Block params autocomplete](previews/yield-arguments-autocomplete.png)

### Features

* component desciption (from `ember-cli-addon-docs`)

* component block params autocomplete

### NPM

`npm install els-addon-docs --save-dev`

### Yarn

`yarn add els-addon-docs --dev`

### VSCode

Install: [Unstable Ember Language Server](https://marketplace.visualstudio.com/items?itemName=lifeart.vscode-ember-unstable).

* Restart `VSCode`.

## Usage

`*` you have to have installed addons, having public documentation page, created by `ember-cli-addon-docs`.

For example:

* [ember-flatpickr](https://shipshapecode.github.io/ember-flatpickr/)

* [ember-yeti-table](https://miguelcobain.github.io/ember-yeti-table/)

* [ember-file-upload](https://adopted-ember-addons.github.io/ember-file-upload/)

[and others](https://github.com/ember-learn/ember-cli-addon-docs/network/dependents?package_id=UGFja2FnZS01MTIzMzk3Mg%3D%3D)

Install `els-addon-docs` as `dev-dependency` in your porject.

Restart editor.

Try type `<` inside component template.

## Is it stable?

* sometimes it may crash your language server, don't worry.