https://github.com/github-language-server/github-lsp
A simple LSP for helping with local edits of Wiki and README
https://github.com/github-language-server/github-lsp
github language-server lsp lsp-server
Last synced: about 16 hours ago
JSON representation
A simple LSP for helping with local edits of Wiki and README
- Host: GitHub
- URL: https://github.com/github-language-server/github-lsp
- Owner: github-language-server
- License: mit
- Created: 2024-03-01T12:27:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T10:15:56.000Z (about 1 year ago)
- Last Synced: 2025-01-16T11:45:09.661Z (about 1 year ago)
- Topics: github, language-server, lsp, lsp-server
- Language: Rust
- Homepage:
- Size: 797 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# github-lsp
[](https://asciinema.org/a/645196)
[](https://github.com/github-language-server/github-lsp/actions/workflows/ci.yml)
https://asciinema.org/a/645195
`github-lsp` is an implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for working with [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) files.
This is a tool for getting link suggestions while writing READMEs and GitHub Wiki pages locally.
Use this LSP in conjunction with some other Markdown LSP if you want gotoDefinition et.al. This LSP only focuses on adding autocomplete to
- [x] `#` Issues and PRs
- [x] `[` Public Wiki Pages
- [x] `:` Organizations / Owners
- [x] `/` Repositories (yours and the orgs you are part of, no global search yet)
- [x] `@` Organization Members
[Issues](https://github.com/github-language-server/github-lsp/issues) and [PRs](https://github.com/github-language-server/github-lsp/pulls) are very welcome!
## Requirements
This LSP uses the amazing [gh](https://cli.github.com/) so you will need to install that and auth with it.
We currently use it for retrieving your auth token, and for meta about the current repo.
```shell
gh auth login
```
## Install
```shell
cargo install --git https://github.com/github-language-server/github-lsp
```
```shell
git clone git@github.com:alexanderbrevig/github-lsp # here you can see why : is for owners and / is for repositories
cd github-lsp
cargo install --path .
```
You can now configure your editor to use this LSP on `stdio`.
## Items added by LSP
### `#` trigger
[#1: Example open issue](https://github.com/github-language-server/github-lsp/issues/1)
[#2: Example closed issue](https://github.com/github-language-server/github-lsp/issues/2)
### `@` trigger
[AlexanderBrevig](https://github.com/AlexanderBrevig)
### `:` trigger
[github-language-server](https://github.com/github-language-server)
### `/` trigger
[github-language-server/github-lsp](https://github.com/github-language-server/github-lsp)
### `[` trigger (Home is always suggested)
[Home](https://github.com/github-language-server/github-lsp/wiki)