Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update config.mts to include all config sections. #689

Merged
merged 2 commits into from
Dec 21, 2024
Merged

doc: update config.mts to include all config sections. #689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6489bca
doc: update config.mts to include all config sections.
milanglacier Dec 21, 2024
e6e1a7f
docs: move recipes to root
Saghen Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/.vitepress/config.mts
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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