NyaoVim

Dies ist ein Neovim -Frontend, das auf Elektron gebaut wurde. Der Neovim -Editor wird als Webkomponente komponiert und Benutzer können die Benutzeroberfläche mit wiederverwendbaren Webkomponenten, HTML, CSS und JavaScript erweitern.

:help design-not :

Verwenden Sie VIM als Komponente aus einer Schale oder in einer IDE.

Nyaovim ist im gleichen Geist gebaut. NYAOVIM enthält den Neovim -Editor als Webkomponente und erweitert seine Benutzeroberfläche mit Web -Technologie, wie bei anderen modernen Redakteuren und IDES (z. B. Atom, vs Code, LightTable).

Ziele

• NYAOVIM Bündel keine erweiterte Benutzeroberfläche. Es bietet nur die schöne UI -Plugin -Architektur. Benutzer können ihre bevorzugte Benutzeroberfläche mit Webkomponenten, HTML und CSS komponieren. Es ist auch einfach, eine NYAOVIM -Verteilung zu erstellen, bei der nützliche Komponenten gebündelt sind.
• Stellen Sie keinen anderen Plugin -Manager vor. HTML für Webkomponenten sollte mit VIM -Plugins gebündelt werden. Daher kann ein VIM -Plugin -Manager UI -Komponenten verarbeiten und uns JS- und VIM -Skriptcode bündeln lassen.
• Verlieren Sie die Bequemlichkeit von Vim nicht standardmäßig. Es sollte sich der Leistung bewusst sein.
• UI -Komponenten -Ersteller können leistungsstarke APIs, Pakete und Werkzeuge verwenden . Node.js-APIs, Elektronen-APIs, Neovim MSGPack-RPC-APIs), so viele NPM-Pakete und Chrome Devtools.
• Cross Platform (Linux, OS X, Windows)

Memo: 'Nyao' ist auf Japanisch 'miau' und sein Aussprechen ähnelt 'Neo'. Es ist auch ein Akronym für "kein anderes Original".

App -Struktur

NYAOVIM besteht aus Webkomponenten auf Elektronen, wie in der folgenden Abbildung gezeigt. Zuerst gibt es nur <neovim-editor> und Sie können zusätzliche Komponenten hinzufügen/entfernen.

UI -Plugin -Beispiele

UI -Plugins sind so einfach wie normale Plugins installierbar. Jeder von ihnen ist innerhalb von 100 ~ 300 Zeilen geschrieben. Sie können auch wiederverwendbare Webkomponenten erstellen und in NYAOVIM integrieren.

• NYAOVIM-MARKDOWN-Präview

• NYAOVIM-POPUP-TOOLTIP

• Nyaovim-mini-Browser

Verwendung

Erste Schritte

Sie können NYAOVIM als NPM -Paket installieren. Derzeit ist noch keine Verpackungsveröffentlichung verfügbar. Wenn Sie Windows verwenden und Neovim noch nicht installiert haben, lesen Sie bitte zuerst die ersten Tipps.

$ npm install -g nyaovim

npm benötigt möglicherweise sudo , wenn Sie node Pacakge über den Systempaketmanager installiert haben.

Wenn Sie Neovim noch nicht installiert haben, installieren Sie es bitte nach den Anweisungen von Neovim, da NYAOVIM intern den Befehl nvim verwendet. Beachten Sie, dass nvim v0.1.6 oder höher erforderlich ist.

Sie können NYAOVIM mit dem Befehl nyaovim starten, wenn Sie diese App mit NPM installieren.

$ nyaovim [files...]

Sie würden einen minimalen Neovim -GUI -Editor (wie GVIM) sehen. Dies ist eine Elektronen -App und Neovim wird auf <canvas> gezeichnet. Sie können die Devtools dieser App mit dem Menüelement "Entwicklertools" sehen.

Beim ersten Start von Nyaovim wird ~/.config/nyaovim/nyaovimrc.html für die UI -Konfiguration ( %AppData% statt .config in Windows) erstellt. Ja, Sie können UI -Komponenten mit HTML und CSS erweitern und konfigurieren!

Konfigurieren von Editoroptionen

Ich denke du denkst jetzt: 'Hmm, Schrift ist nicht gut und zu klein ...'. Sie können einige Editoroptionen nach Eigenschaften von <neovim-editor> -Formen konfigurieren. Konfiguriert beispielsweise unten die Schriftart und die Schriftgröße für font und font-size . Setzen Sie dann die Zeilenhöhe auf 1,5 (zum Beispiel nimmt Atom 1,5 als Zeilenhöhe an).

 < neovim-editor
    id =" nyaovim-editor "
    argv =" [[argv]] "
    font-size =" 14 "
    font =" Ricty,monospace "
    line-height =" 1.5 "
> </ neovim-editor >

Sie können auch Browser-Fensteroptionen mit browser-config.json (z. B. Erhaltungsfensterstatus, Einzelinstanz-App usw.) konfigurieren. Weitere Informationen finden Sie in Tipps.

UI -Plugin installieren

Lassen Sie uns beispielsweise NYAOVIM-Popup-Tooltip installieren.

Wie im Abschnitt der Ziele beschrieben, ist ein UI -Plugin ein normales Neovim -Plugin. Sie können es wie jedes andere Neovim -Plugin installieren. Wenn Sie VIM-Plug verwenden, müssen Sie nur noch zu Ihrem init.vim hinzufügen.

Plug ' rhysd/nyaovim-popup-tooltip '

Anschließend müssen Sie die UI von Popup Tooltip auf Ihre NYAOVIM -Schnittstelle setzen. Bitte öffnen Sie ~/.config/nyaovim/nyaovimrc.html ( %AppData% anstelle von .config in Windows). Wie im Abschnitt Ziele beschrieben, kann ein Benutzer eine Benutzeroberfläche mit HTML und CSS mit hoher Anpassung erstellen.

Bitte fügen Sie unter <popup-tooltip> Tag unter <neovim-editor> tag wie unten hinzu

 < neovim-editor id =" nyaovim-editor " argv =" [[argv]] " > </ neovim-editor >
< popup-tooltip editor =" [[editor]] " > </ popup-tooltip >

<popup-tooltip> ist eine Polymerkomponente. editor="[[editor]]" ist eine Datenbindung im Polymer-Framework, um die Editorinstanz an <popup-tooltip> zu übergeben. Dies bedeutet, dass ein unidirektionaler Datenfluss vom Elternteil zu Kind fließen.

Nachdem Sie NYAOVIM-Popup-Tooltip als Neovim-Plugin installiert und HTML hinzugefügt haben, sind Sie alle fertig! Öffnen Sie Nyaovim, bewegen Sie den Cursor auf einen beliebigen Bildpfad und geben Sie gi ein. NYAOVIM lädt das Bild und zeigt es in einem Popup -Tooltip wie unten.

Unterlagen

Es gibt mehr Dokumentation im DOCS -Verzeichnis.

• So machen Sie UI -Plugin
• Tipps
• FAQ
• Laufzeit -API
• Browser -Konfiguration

Versioning

Nyaovim steht jetzt unter Beta -Phase. Die Hauptversion wird auf 0 repariert, bis sie eine stabile Version erhält.

Durch die Aktualisierung der kleinen Version enthält es brechende Änderungen. Das Aktualisieren von Patch -Versionen bedeutet, dass sie keine Bruchänderung enthält, sodass Sie die Version einfach aktualisieren können.

Lizenz

MIT -Lizenz.

Das Logo dieser App wird basierend auf dem NEOVIM -Logo erstellt, das unter CCA 3.0 -Unported lizenziert ist.

Das Neovim -Logo von Jason Long ist unter der nichtportierten Lizenz der Creative Commons Attribution 3.0 lizenziert.