Skip to content

Commit

Permalink
docs: add asciinema demo (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderBrevig committed Mar 4, 2024
2 parents 5999754 + 34a9e86 commit 7147e11
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# github-lsp

[![https://asciinema.org/a/645196](demo.gif)](https://asciinema.org/a/645196)

[![CI](https://github.com/AlexanderBrevig/github-lsp/actions/workflows/ci.yml/badge.svg)](https://github.com/AlexanderBrevig/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
* [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/AlexanderBrevig/github-lsp/issues) and [PRs](https://github.com/AlexanderBrevig/github-lsp/pulls) are very welcome!

Expand Down
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7147e11

Please sign in to comment.