orgize/orgize-lsp/README.md
2023-12-21 23:51:42 +08:00

56 lines
801 B
Markdown

# `orgize-lsp`
Language server for org-mode, builtin with [`orgize`].
[`orgize`]: https://crates.io/crates/orgize
## Install
### Server
```sh
$ cargo install --path .
```
### Client (vscode)
```sh
$ pnpm run -C editors/vscode package --no-dependencies
$ code --install-extension ./editors/vscode/orgize-lsp.vsix --force
```
## Supported features
1. Folding range
- Fold headline, list, table, blocks
2. Document symbols
- Headings
3. Formatting
4. Document link
- File links
- Source block `:tangle` arguments
- Internal links
5. Code lens
- Generate toc heading
- Tangle/detanlge source block
- Evaluate source block
6. Completion
- Various blocks: `<a`, `<c`, `<C`, `<e`, `<E`, `<h`, `<l`, `<q`, `<s`, `<v`, `<I`
7. Commands
- Show syntax tree