a09e5d255b
## Why? Some users expressed a preference for the AnyQuotes and AnyBrackets text objects to align more closely with traditional Vim behavior, rather than the mini.ai plugin's approach. To address this, I’ve introduced two new text objects: MiniQuotes and MiniBrackets. These retain the mini.ai plugin behavior, while the updated AnyQuotes and AnyBrackets now follow the logic described in [this bug report](https://github.com/zed-industries/zed/issues/25563) and [this bug report](https://github.com/zed-industries/zed/issues/25562). ## Behavior Overview: ### AnyQuotes and AnyBrackets: These now prioritize the innermost range first (e.g., the closest quotes or brackets). If none are found, they fall back to searching the current line. This aligns with the behavior requested in the issue. ### MiniQuotes and MiniBrackets: These maintain the mini.ai plugin behavior, prioritizing the current line before expanding the search outward. ### Usage Examples: AnyQuotes: Works like ```ci', ci", ci` , ca', ca", ca` , etc.``` AnyBrackets: Works like ```ci(, ci[, ci{, ci<, ca(, ca[, ca{, ca<, etc.``` Please give these changes a try and let me know your thoughts! ### Release Notes: - vim: Add AnyQuotes, AnyBrackets, MiniQuotes and MiniBrackets text objects --------- Co-authored-by: Ben Kunkle <ben@zed.dev> |
||
|---|---|---|
| .. | ||
| src | ||
| theme | ||
| .gitignore | ||
| .prettierignore | ||
| book.toml | ||
| README.md | ||
Zed Docs
Welcome to Zed's documentation.
This is built on push to main and published automatically to https://zed.dev/docs.
To preview the docs locally you will need to install mdBook (cargo install mdbook) and then run:
mdbook serve docs
Before committing, verify that the docs are formatted in the way prettier expects with:
cd docs && pnpm dlx prettier@3.5.0 . --write && cd ..
Preprocessor
We have a custom mdbook preprocessor for interfacing with our crates (crates/docs_preprocessor).
If for some reason you need to bypass the docs preprocessor, you can comment out [preprocessor.zed_docs_preprocessor] from the book.toml.:
Images and videos
To add images or videos to the docs, upload them to another location (e.g., zed.dev, GitHub's asset storage) and then link out to them from the docs.
Putting binary assets such as images in the Git repository will bloat the repository size over time.
Internal notes:
- We have a Cloudflare router called
docs-proxythat intercepts requests tozed.dev/docsand forwards them to the "docs" Cloudflare Pages project. - CI uploads a new version to the Pages project from
.github/workflows/deploy_docs.ymlon every push tomain.
Table of Contents
The table of contents files (theme/page-toc.js and theme/page-doc.css) were initially generated by mdbook-pagetoc.
Since all this preprocessor does is generate the static assets, we don't need to keep it around once they have been generated.
Referencing Keybindings and Actions
When referencing keybindings or actions, use the following formats:
Keybindings:
{#kb scope::Action} - e.g., {#kb zed::OpenSettings}.
This will output a code element like: <code>Cmd+,|Ctrl+,</code>. We then use a client-side plugin to show the actual keybinding based on the user's platform.
By using the action name, we can ensure that the keybinding is always up-to-date rather than hardcoding the keybinding.
Actions:
{#action scope::Action} - e.g., {#action zed::OpenSettings}.
This will render a human-readable version of the action name, e.g., "zed: open settings", and will allow us to implement things like additional context on hover, etc.
Creating New Templates
New templates can be created by implementing the Template trait for your desired template in the docs_preprocessor crate.
References
- Template Trait: crates/docs_preprocessor/src/templates.rs
- Example template: crates/docs_preprocessor/src/templates/keybinding.rs
- Client-side plugins: docs/theme/plugins.js