From 7fdb978d706fd56c884451cfcdbd987442fcc004 Mon Sep 17 00:00:00 2001 From: milanglacier Date: Sat, 21 Dec 2024 14:33:02 -0500 Subject: [PATCH] docs: update config.mts to include all config sections (#689) * doc: update config.mts to include all config sections. * docs: move recipes to root --------- Co-authored-by: Liam Dyer --- docs/.vitepress/config.mts | 2 ++ docs/configuration/general.md | 2 +- docs/configuration/sources.md | 2 +- docs/{configuration => }/recipes.md | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) rename docs/{configuration => }/recipes.md (97%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index fd4ded4f..ca0eef4c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -12,12 +12,14 @@ export default defineConfig({ sidebar: [ { text: 'Introduction', link: '/' }, { text: 'Installation', link: '/installation' }, + { text: 'Recipes', link: '/configuration/recipes' }, { text: 'Configuration', items: [ { text: 'General', link: '/configuration/general' }, { text: 'Appearance', link: '/configuration/appearance' }, { text: 'Completion', link: '/configuration/completion' }, + { text: 'Fuzzy', link: '/configuration/fuzzy' }, { text: 'Keymap', link: '/configuration/keymap' }, { text: 'Signature', link: '/configuration/signature' }, { text: 'Sources', link: '/configuration/sources' }, diff --git a/docs/configuration/general.md b/docs/configuration/general.md index 00e1cddd..b4c2a2f9 100644 --- a/docs/configuration/general.md +++ b/docs/configuration/general.md @@ -2,7 +2,7 @@ Blink cmp has *a lot* of configuration options, the following code block highlights some changes you're most likely to care about. For more information, check out the additional pages. -For more common configurations, see the [recipes](./recipes.md). +For more common configurations, see the [recipes](../recipes.md). ```lua { diff --git a/docs/configuration/sources.md b/docs/configuration/sources.md index e1feb408..fc9c619a 100644 --- a/docs/configuration/sources.md +++ b/docs/configuration/sources.md @@ -1,7 +1,7 @@ # Sources > [!NOTE] -> Check out the [recipes](./recipes.md) for some common configurations +> Check out the [recipes](../recipes.md) for some common configurations Blink provides a sources interface, modelled after LSPs, for getting completion items, trigger characters, documentation and signature help. The `lsp`, `path`, `snippets`, `luasnip` and `buffer` sources are built-in. You may add additional [community sources](#community-sources) as well. Check out [writing sources](../development/writing-sources.md) to learn how to write your own! diff --git a/docs/configuration/recipes.md b/docs/recipes.md similarity index 97% rename from docs/configuration/recipes.md rename to docs/recipes.md index c53441e8..594339cf 100644 --- a/docs/configuration/recipes.md +++ b/docs/recipes.md @@ -132,7 +132,7 @@ end ### Disable all snippets -See the [relevant section in the snippets documentation](./snippets.md#disable-all-snippets) +See the [relevant section in the snippets documentation](./configuration/snippets.md#disable-all-snippets) ### Set minimum keyword length by filetype