https://github.com/liuderchi/ide-yaml

:atom: Atom-IDE support for YAML language
https://github.com/liuderchi/ide-yaml

atom-editor atom-ide atom-package atom-plugin language-server-protocol yaml yaml-parser

Last synced: 3 months ago
JSON representation

:atom: Atom-IDE support for YAML language

• Host: GitHub
• URL: https://github.com/liuderchi/ide-yaml
• Owner: liuderchi
• Created: 2017-09-20T16:36:31.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-10-19T10:35:24.000Z (over 1 year ago)
• Last Synced: 2023-10-19T11:36:28.842Z (over 1 year ago)
• Topics: atom-editor, atom-ide, atom-package, atom-plugin, language-server-protocol, yaml, yaml-parser
• Language: JavaScript
• Homepage: https://atom.io/packages/ide-yaml
• Size: 4.55 MB
• Stars: 19
• Watchers: 2
• Forks: 7
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# ide-yaml

[![apm-download-count][apm-download-count]][apm-download-link]

[![ci-status][ci-status]][ci-link]

[![dependency-status][david-status]][david-project]

Atom-IDE support for YAML language

![demo1][demo1]

![demo2][demo2]

## Features

  - YAML Outline in *Outline View*

      - Quick navigation by clicking

      - Searching by entering keywords

  - Tooltips for

      - Linter message

## Requirements

you need to install following requirements before installing [`ide-yaml`][apm-download-link]:

  - Atom editor *1.21.0-beta0* or higher version

  - Atom package [`atom-ide-ui`][atom-ide-ui]

## FAQ

> Why I could not download this Atom package?

Please make sure you have installed all softwares in [*Requirements*](#requirements) section.

---

> I've installed ide-yaml. Why there is still nothing shown in Outline View when yaml opened?

Please check the file exists in the *Project Tree View* so that it can be handled by [`ide-yaml`][apm-download-link].

In addition, to show outline view, use Atom command `Outline View: Toggle`.

---

> How can I customize this package?

Please read [CONTRIBUTING.md][CONTRIBUTING.md] for more details.

---

  - :confused: Still feeling confused? Please [provide feedbacks via issues][create-issue] to make ide-yaml better. :pray:

## Notes and References

  - [`ide-yaml`][apm-download-link] acts as a *client* of language server basing on [`atom-languageclient`][atom-languageclient]

  - [`yaml-language-server`][yaml-language-server] acts as a *language server* and analyze your YAML in separate process

  - language servers and clients are talking with [Language Server Protocol (LSP)][lsp]

## License

[MIT License][mit-license]

[apm-download-count]: https://img.shields.io/apm/dm/ide-yaml.svg "apm-download-count"

[apm-download-link]: https://atom.io/packages/ide-yaml "apm-download-link"

[ci-status]: https://github.com/liuderchi/ide-yaml/actions/workflows/ci.yml/badge.svg "ci-status"

[ci-link]: https://github.com/liuderchi/ide-yaml/actions "ci-link"

[david-status]: https://david-dm.org/liuderchi/ide-yaml.svg "david-status"

[david-project]: https://david-dm.org/liuderchi/ide-yaml "david-project"

[demo1]: https://user-images.githubusercontent.com/4994705/30978941-b57d0f08-a441-11e7-84c7-c832b64c337d.png "demo1"

[demo2]: https://user-images.githubusercontent.com/4994705/30978942-b5ad6a0e-a441-11e7-989d-25db64fc33d1.png "demo2"

[atom-ide-ui]: https://atom.io/packages/atom-ide-ui "atom-ide-ui"

[CONTRIBUTING.md]: https://github.com/liuderchi/ide-yaml/blob/main/CONTRIBUTING.md "CONTRIBUTING.md"

[create-issue]: https://github.com/liuderchi/ide-yaml/issues/new "create-issue"

[atom-languageclient]: https://github.com/atom/atom-languageclient "atom-languageclient"

[yaml-language-server]: https://github.com/redhat-developer/yaml-language-server "yaml-language-server"

[lsp]: http://langserver.org/ "lsp"

[mit-license]: https://liuderchi.mit-license.org/ "mit-license"