History

Kirill Bulatov bc113e4b51 Move task centering code closer to user input (#22082 ) Follow-up of https://github.com/zed-industries/zed/pull/22004 * Reuse center terminals for tasks, when requested * Extend task templates with `RevealTarget`, moving it from `TaskSpawnTarget` into the core library * Use `reveal_target` instead of `target` to avoid misinterpretations in the task template context * Do not expose `SpawnInTerminal` to user interface, avoid it implementing `Serialize` and `Deserialize` * Remove `NewCenterTask` action, extending `task::Spawn` interface instead * Do not require any extra unrelated parameters during task resolution, instead, use task overrides on the resolved tasks on the modal side * Add keybindings for opening the task modal in the `RevealTarget::Center` mode Release Notes: - N/A		2024-12-16 16:15:58 +02:00
..
src	Move task centering code closer to user input (#22082 )	2024-12-16 16:15:58 +02:00
theme	docs: Add tweaks to the outline panel page (#18697 )	2024-10-03 12:27:42 -03:00
.gitignore	Setup docs deployments with mdBook (#11369 )	2024-05-03 15:52:15 -04:00
.prettierignore	docs: Check formatting in CI (#15355 )	2024-07-27 15:47:48 -04:00
book.toml	docs: Add redirect for /conversations (#20170 )	2024-11-04 09:56:07 -05:00
README.md	Don't rely on relative path for docs preprocessor (#16883 )	2024-08-26 11:43:13 -04:00

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

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-proxy that intercepts requests to zed.dev/docs and forwards them to the "docs" Cloudflare Pages project.
CI uploads a new version to the Pages project from .github/workflows/deploy_docs.yml on every push to main.

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