☁️ NeoVim Server

\n A containerized IDE-like text editor that runs on a web server\n

\n\n

\n \n $\"CICD\"/$ \n \n $\"License\"/$ \n \n $\"Version\"$ \n \n \n $\"NeoVim\"/$ \n \n \n $\"Platform\"/$ \n \n

\n\nThis tool is for running NeoVim remotely and continuing the development process at 🚀 speed.\nYou can use it to implement an IDE-like web-based terminal text editor.\n\n![screenshot](https://github.com/yqlbu/neovim-server/raw/master/demo.gif)\n\n## ✨ Features\n\n- Portable and light-weight\n- Support popular languages\n- Syntax highlight\n- Intellisense autocomplete\n- Markdown snippets and preview\n- Easy to deploy\n- Versatile and customizable\n- Containerized\n- Run on a web browser\n- Build with multi-arch (ARM/x86)\n- Supported platforms: `arm64`, `arm64`, `arm/v7`\n\n## ⚙️ Prerequisites\n\n- `Driod Sans Mono Nerd Font` is required to be downloaded since its the default font of the container. You may find the installation guide below. To use other fonts, please find the instructions on the [Nerd Font](https://github.com/ryanoasis/nerd-fonts) repository.\n- Choose a web browser in your preference. Google Chrome, Microsoft Edge, and FireFox should work fine, whereas Safari does not work temporarily.\n\n## 📥 Font Installation\n\nNotes: `reboot` might be needed after the font installation\n\n#### Linux\n\n```bash\nmkdir -p ~/.local/share/fonts\ncd ~/.local/share/fonts && curl -fLo \"Droid Sans Mono for Powerline Nerd Font Complete.otf\" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf\n```\n\n#### MacOS\n\n```bash\ncd ~/Library/Fonts && curl -fLo \"Droid Sans Mono for Powerline Nerd Font Complete.otf\" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf\n```\n\n#### Arch User ONLY\n\n```bash\nyay -S nerd-fonts-droid-sans-mono\n```\n\n**NOTE:** if your current browser cannot load the `font` and the `icon`, you may manually apply the configuration to the wetty configuration window located on the upper right corner:\n\n```json\n{\n \"fontSize\": 16,\n \"fontFamily\": \"DroidSansMono Nerd Font\"\n}\n```\n\n## 📥 Installation\n\n#### Run with the pre-built image\n\n```bash\ndocker run -d \\\n --name nvim-server \\\n --restart unless-stopped \\\n -p 6080:3000 \\\n -p 8090:8090 \\\n -v ~/workspace:/workspace \\\n -v /appdata/nvim-server:/config \\\n -e UID=$UID \\\n -e GId=$GID \\\n -e TZ=Asia/Shanghai \\\n -e USER= \\\n -e SECRET= \\\n hikariai/nvim-server:latest\n```\n\n#### Watch the logs\n\n```bash\n$ docker logs nvim-server --follow\n```\n\nNotes:\n\n- Wait for a couple seconds until the container finishes its bootstrap process, then visit `http://localhost:6080/wetty`\n\n| Parameters | Usage |\n| :-------------------------------: | :---------------------------------------------------------------: |\n| `--name nvim-server` | Specify the name for the container |\n| `-p 6080:3000` | Map the port for accessing the Web UI |\n| `-p 8090:8090` | Map the port for the Instant Markdown Preview Server |\n| `-v ~/workspace:/workspace` | Map the working directory |\n| `-v /appdata/nvim-server:/config` | Contain all relevant configuration config directory |\n| `-e UID=$UID` | Map current user ID |\n| `-e GID=$GID` | Map current group ID |\n| `-e TZ=` | Specify a timezone to use e.g. `Asia/Shanghai` |\n| `-e USER=` | Specify the username for user login, default is set to `guest` |\n| `-e SECRET=` | Specify the password for user login, default is set to `password` |\n\n#### Build the image manually\n\nFollow the instruction [HERE](https://github.com/yqlbu/neovim-server/wiki/Installation#build-container-image-manually)\n\n#### UNRAID User ONLY\n\n`NeoVim Sever` is now available on `unRAID CA`. Search `nvim server` and install\n\nDetailed installation guide is available [HERE](https://github.com/yqlbu/unraid-templates)\n\n## 💡 Usage\n\n- After logging in with `username` and `password` in the web console, type `vim` to finish the initial setup.\n\n- For the first launch, NeoVim will install the coc-extensions defined in [coc.settings](https://github.com/yqlbu/neovim-server/blob/master/nvim/coc-settings.json). You may also download additional coc-extensions followed by the [instructions](https://github.com/neoclide/coc.nvim/wiki/Using-coc-extensions)\n\n- All the functionalities and usage cases are written in the [Wiki Page](https://github.com/yqlbu/neovim-server/wiki), feel free to check it out.\n\n- To get familiar with the default key mappings, please visit the [Cheat Sheet Page](https://github.com/yqlbu/neovim-server/wiki/Cheat-sheet)\n\n## 📋 Wiki\n\n- [Wiki (EN)](https://github.com/yqlbu/neovim-server/wiki)\n\n## 💬 F.A.Q\n\n- [F.A.Q (EN)](https://github.com/yqlbu/neovim-server/wiki/F.A.Q)\n\n## 🔨 Useful Tools for Vim\n\n- [Vim Cheatsheet Diagram](https://quickref.me/vim)\n- [Vim Official Tutorials](https://www.tutorialspoint.com/vim/vim_macros.htm)\n\n## 📝 TODO\n\n- [ ] Add a customizable base image\n- [ ] Add more customizable features\n- [ ] Add more advanced usage cases\n- [ ] Add demo and usage guide for selection, registers, substitution, and macro\n- [ ] Add SSL support\n- [x] Add relative number option\n- [ ] Add wetty rolling updates\n\n## 📝 Reference\n\n- [wetty repository](https://github.com/butlerx/wetty)\n- [neovim repository](https://github.com/neovim/neovim)\n- [coc-nvim repository](https://github.com/neoclide/coc.nvim)\n\n## ⚖️ License\n\n[MIT (C) Kevin Yu](https://github.com/yqlbu/neovim-server/blob/master/LICENSE)\n","has_starred","hub_user","immutable_tags_settings",{"_149":11,"_150":151},"enabled","rules",[152],".*","is_automated","permissions",{"_156":17,"_157":11,"_158":11},"read","write","admin","user","storage_size",360018963427,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_22":23,"_111":-7,"_109":-7,"_110":-7,"_24":172,"_39":40,"_177":178,"_183":11},{"_26":27,"_28":29,"_30":31,"_32":33,"_34":173,"_66":67,"_68":29,"_69":70,"_71":72,"_73":74,"_75":76,"_77":63,"_78":67,"_79":53,"_80":17},[174,175,176],{"_37":38,"_39":40,"_41":42,"_43":44,"_45":46,"_47":48,"_49":42,"_50":-5,"_51":31,"_52":53,"_54":-5},{"_37":56,"_39":57,"_41":42,"_43":58,"_45":46,"_47":48,"_49":42,"_50":-5,"_51":59,"_52":53,"_54":-5},{"_37":61,"_39":62,"_41":42,"_43":63,"_45":46,"_47":48,"_49":42,"_50":-5,"_51":64,"_52":53,"_54":65},"imageWithLayers",{"_37":38,"_39":40,"_41":42,"_43":44,"_45":46,"_84":179,"_47":48,"_49":42,"_50":-5,"_51":31,"_52":53,"_54":-5},[180,181,182],{"_39":98,"_51":31,"_88":99},{"_51":91,"_88":92,"_39":42},{"_51":91,"_88":94,"_39":42},"hasPermissionToViewRepoSettings","actionData","errors"]

hikariai/nvim-server:test