Skip to content

Commit

Permalink
docs: update config.mts to include all config sections (#689)
Browse files Browse the repository at this point in the history
* doc: update config.mts to include all config sections.

* docs: move recipes to root

---------

Co-authored-by: Liam Dyer <liamcdyer@gmail.com>
  • Loading branch information
milanglacier and Saghen authored Dec 21, 2024
1 parent 3cb7208 commit 7fdb978
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/sources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Sources <a href="./reference#sources"><Badge type="info" text="Go to default configuration" /></a>

> [!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!

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/recipes.md → docs/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7fdb978

Please sign in to comment.