From f0a858f77311fff3c1d2c35a56a65706401c0476 Mon Sep 17 00:00:00 2001 From: Artemy Egorov Date: Wed, 14 Aug 2024 21:34:55 +0300 Subject: [PATCH] doc: add help center --- README.md | 2 ++ help/editors/helix.md | 20 ++++++++++++++++++++ help/editors/main.md | 3 +++ help/main.md | 3 +++ 4 files changed, 28 insertions(+) create mode 100644 help/editors/helix.md create mode 100644 help/editors/main.md create mode 100644 help/main.md diff --git a/README.md b/README.md index bb9c184..9bb1195 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Markup language ecosystem сombining small file size, big number of possibilitie [Rust implementation](https://github.com/TxtDot/dalet-rs) +[Help center](./help/main.md) + > [!WARNING] > Specification and rust implementation is not complete and very unstable. diff --git a/help/editors/helix.md b/help/editors/helix.md new file mode 100644 index 0000000..bc51553 --- /dev/null +++ b/help/editors/helix.md @@ -0,0 +1,20 @@ +1. Install dalet_lsp `cargo install daleth_lsp` +2. Add this to languages.toml: + +```toml +[[language]] +name = "daleth" +language-servers = ["daleth-lsp"] +scope = "source.daleth" +file-types = ["dlth"] + +[language-server.daleth-lsp] +command = "daleth_lsp" + +[[grammar]] +name = "daleth" + +[grammar.source] +git = "https://github.com/TxtDot/tree-sitter-daleth" +rev = "HEAD" +``` diff --git a/help/editors/main.md b/help/editors/main.md new file mode 100644 index 0000000..a500b08 --- /dev/null +++ b/help/editors/main.md @@ -0,0 +1,3 @@ +# Editors support + +- [helix](./helix.md) diff --git a/help/main.md b/help/main.md new file mode 100644 index 0000000..1240180 --- /dev/null +++ b/help/main.md @@ -0,0 +1,3 @@ +# Help center + +- [Editors support](./editors/main.md)