1<!DOCTYPE HTML>
2<html lang="{{ language }}" dir="{{ text_direction }}">
3 <head>
4 <!-- Book generated using mdBook -->
5 <meta charset="UTF-8">
6 <style>
7 @view-transition {
8 navigation: auto;
9 }
10 ::view-transition-old(root),
11 ::view-transition-new(root) {
12 animation-duration: 0.05s;
13 }
14 </style>
15 <!-- Theme initialization - must run before any CSS loads to prevent flicker -->
16 <script>
17 (function() {
18 var theme;
19 try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
20 if (theme === null || theme === undefined) {
21 theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";
22 }
23 var html = document.documentElement;
24 html.setAttribute('data-theme', theme);
25 html.setAttribute('data-color-scheme', theme);
26 html.className = theme;
27 })();
28 </script>
29 <title>{{ title }}</title>
30 {{#if is_print }}
31 <meta name="robots" content="noindex">
32 {{/if}}
33 {{#if base_url}}
34 <base href="{{ base_url }}">
35 {{/if}}
36
37
38 <!-- Custom HTML head -->
39 {{> head}}
40
41 <meta name="description" content="#description#">
42 <meta name="viewport" content="width=device-width, initial-scale=1">
43 <meta name="theme-color" content="#ffffff">
44
45 <link rel="shortcut icon" href="{{ path_to_root }}favicon.png">
46 <link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
47 <link rel="stylesheet" href="{{ path_to_root }}css/general.css">
48 <link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">
49 {{#if print_enable}}
50 <link rel="stylesheet" href="{{ path_to_root }}css/print.css" media="print">
51 {{/if}}
52
53 <!-- Fonts -->
54 <link rel="stylesheet" href="{{ path_to_root }}FontAwesome/css/font-awesome.css">
55 {{#if copy_fonts}}
56 <link rel="stylesheet" href="{{ path_to_root }}fonts/fonts.css">
57 {{/if}}
58
59 <!-- Highlight.js Stylesheets -->
60 <link rel="stylesheet" href="{{ path_to_root }}highlight.css">
61 <link rel="stylesheet" href="{{ path_to_root }}tomorrow-night.css">
62 <link rel="stylesheet" href="{{ path_to_root }}ayu-highlight.css">
63
64 <!-- Custom theme stylesheets -->
65 {{#each additional_css}}
66 <link rel="stylesheet" href="{{ ../path_to_root }}{{ this }}">
67 {{/each}}
68
69 {{#if mathjax_support}}
70 <!-- MathJax -->
71 <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
72 {{/if}}
73 </head>
74 <body class="no-js">
75 <div id="body-container">
76 <div class="noise-pattern" style="background-image: url('https://cdn.zed.dev/images/noise.png');"></div>
77
78 <!-- Provide site root to javascript -->
79 <script>
80 var path_to_root = "{{ path_to_root }}";
81 var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
82 // Mark as JS-enabled
83 document.body.classList.remove('no-js');
84 document.body.classList.add('js');
85 </script>
86
87 <header class="header-bar">
88 <div class="left-container">
89 <a href="/" class="logo-nav">
90 <img src="https://zed.dev/logo_icon.webp" class="icon-logo-img" alt="Zed Industries" style="height: 26px;">
91 </a>
92 <button id="sidebar-toggle" class="icon-button ib-hidden-desktop" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar" aria-expanded="false">
93 <i class="fa fa-bars"></i>
94 </button>
95 </div>
96 {{#if search_enabled}}
97 <button id="search-toggle" class="search-button" type="button" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
98 <i class="icon fa fa-search"></i>
99 <span class="search-content-desktop">
100 <span class="placeholder">Search docs…</span>
101 <kbd>S</kbd>
102 </span>
103 <span class="search-content-mobile">
104 <span class="placeholder">Search…</span>
105 </span>
106 </button>
107 {{/if}}
108 <div class="right-container">
109 <button id="theme-toggle" class="icon-button" type="button" title="Change Theme" aria-label="Change Theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
110 <i class="fa fa-paint-brush"></i>
111 </button>
112
113 <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
114 <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
115 <li role="none"><button role="menuitem" class="theme" id="dark">Dark</button></li>
116 </ul>
117
118 <button id="copy-markdown-toggle" class="icon-button ib-hidden-mobile" type="button" title="Copy Page as Markdown" aria-label="Copy page as markdown">
119 <i class="fa fa-copy"></i>
120 </button>
121
122 <a class="download-button" href="https://zed.dev/download" title="Download Zed" aria-label="Download Zed">
123 Download
124 </a>
125 {{#if git_repository_url}}
126 <a href="{{git_repository_url}}" title="Git repository" aria-label="Git repository">
127 <i id="git-repository-button" class="fa {{git_repository_icon}}"></i>
128 </a>
129 {{/if}}
130 {{#if git_repository_edit_url}}
131 <a href="{{git_repository_edit_url}}" title="Suggest an edit" aria-label="Suggest an edit">
132 <i id="git-edit-button" class="fa fa-edit"></i>
133 </a>
134 {{/if}}
135 </div>
136 </header>
137
138 <div id="page-wrapper" class="page-wrapper">
139
140 {{#if search_enabled}}
141 <div class="search-container">
142 <div id="search-wrapper" class="search-modal hidden">
143 <form id="searchbar-outer" class="searchbar-outer">
144 <input type="search" id="searchbar" name="searchbar" placeholder="Search…" aria-controls="searchresults-outer" aria-describedby="searchresults-header">
145 </form>
146 <div id="searchresults-outer" class="searchresults-outer">
147 <div id="searchresults-header" class="searchresults-header"></div>
148 <ul id="searchresults">
149 </ul>
150 </div>
151 </div>
152 </div>
153 {{/if}}
154
155 <nav id="sidebar" class="sidebar" aria-label="Table of contents">
156 <div class="sidebar-scrollbox">
157 {{#toc}}{{/toc}}
158 </div>
159 <div style="display: none;" id="sidebar-resize-handle" class="sidebar-resize-handle">
160 <div class="sidebar-resize-indicator"></div>
161 </div>
162 </nav>
163
164 <!-- Mobile sidebar toggle -->
165 <script>
166 (function() {
167 var sidebarToggle = document.getElementById('sidebar-toggle');
168 var sidebar = document.getElementById('sidebar');
169
170 sidebarToggle.addEventListener('click', function() {
171 var isOpen = document.body.classList.toggle('sidebar-open');
172 sidebarToggle.setAttribute('aria-expanded', isOpen);
173 sidebar.setAttribute('aria-hidden', !isOpen);
174 });
175
176 // Close sidebar when clicking a link inside it (on mobile)
177 sidebar.addEventListener('click', function(e) {
178 if (e.target.tagName === 'A' && window.innerWidth < 620) {
179 document.body.classList.remove('sidebar-open');
180 sidebarToggle.setAttribute('aria-expanded', 'false');
181 sidebar.setAttribute('aria-hidden', 'true');
182 }
183 });
184 })();
185 </script>
186
187 <!-- Search backdrop handlers -->
188 <script>
189 (function() {
190 var searchWrapper = document.getElementById('search-wrapper');
191 var searchContainer = document.querySelector('.search-container');
192 var searchResults = document.getElementById('searchresults');
193
194 if (!searchWrapper || !searchContainer) return;
195
196 searchContainer.addEventListener('click', function(e) {
197 if (e.target === searchContainer) {
198 searchWrapper.classList.add('hidden');
199 }
200 });
201
202 if (searchResults) {
203 searchResults.addEventListener('click', function(e) {
204 if (e.target.tagName === 'A' || e.target.closest('a')) {
205 searchWrapper.classList.add('hidden');
206 }
207 });
208 }
209 })();
210 </script>
211
212 <!-- Insert section spacers and apply collapsed state before scroll restoration to prevent layout shift/flicker -->
213 <script>
214 (function() {
215 var chapterList = document.querySelector('#sidebar ol.chapter');
216 if (!chapterList) return;
217
218 var collapsedSections = [];
219 try {
220 var stored = sessionStorage.getItem('sidebar-collapsed-sections');
221 if (stored) {
222 collapsedSections = JSON.parse(stored);
223 }
224 } catch (e) {}
225
226 var partTitles = chapterList.querySelectorAll('li.part-title');
227 var previousPartTitle = null;
228
229 partTitles.forEach(function(partTitle, index) {
230 partTitle._sectionName = partTitle.textContent.trim();
231
232 // Insert a spacer before this part-title (except for the first one)
233 if (index > 0) {
234 var spacer = document.createElement('li');
235 spacer.className = 'section-spacer';
236 partTitle.parentNode.insertBefore(spacer, partTitle);
237
238 if (previousPartTitle) {
239 previousPartTitle._spacerAfter = spacer;
240 }
241 }
242
243 var isCollapsed = collapsedSections.includes(partTitle._sectionName);
244 if (isCollapsed) {
245 // Hide all siblings until next part-title
246 var sibling = partTitle.nextElementSibling;
247 while (sibling && !sibling.classList.contains('part-title')) {
248 sibling.classList.add('section-hidden');
249 sibling = sibling.nextElementSibling;
250 }
251 // Hide the spacer after this section (will be set on next iteration)
252 partTitle._isCollapsed = true;
253 }
254
255 // If previous section was collapsed, hide its spacer
256 if (previousPartTitle && previousPartTitle._isCollapsed && previousPartTitle._spacerAfter) {
257 previousPartTitle._spacerAfter.classList.add('section-hidden');
258 }
259
260 previousPartTitle = partTitle;
261 });
262
263 // Handle the last section's spacer if it was collapsed
264 if (previousPartTitle && previousPartTitle._isCollapsed && previousPartTitle._spacerAfter) {
265 previousPartTitle._spacerAfter.classList.add('section-hidden');
266 }
267 })();
268 </script>
269
270 <!-- Track and set sidebar scroll position -->
271 <script>
272 var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
273 sidebarScrollbox.addEventListener('click', function(e) {
274 if (e.target.tagName === 'A') {
275 sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
276 }
277 }, { passive: true });
278 var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
279 sessionStorage.removeItem('sidebar-scroll');
280 if (sidebarScrollTop) {
281 // preserve sidebar scroll position when navigating via links within sidebar
282 sidebarScrollbox.scrollTop = sidebarScrollTop;
283 } else {
284 // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
285 var activeSection = document.querySelector('#sidebar .active');
286 if (activeSection) {
287 activeSection.scrollIntoView({ block: 'center' });
288 }
289 }
290 </script>
291
292 <div class="page">
293 <div id="content" class="content">
294 <main>
295 {{{ content }}}
296 <div class="footer-buttons">
297 {{#previous}}
298 <a rel="prev" href="{{ path_to_root }}{{link}}" class="footer-button" title="{{title}}">
299 <i class="fa fa-angle-left"></i>
300 {{title}}
301 </a>
302 {{/previous}}
303 {{#next}}
304 <a rel="next" href="{{ path_to_root }}{{link}}" class="footer-button" title="{{title}}">
305 {{title}}
306 <i class="fa fa-angle-right"></i>
307 </a>
308 {{/next}}
309 </div>
310 <footer class="footer">
311 <a href="/" class="logo-nav">
312 <img
313 src="https://zed.dev/logo_icon.webp"
314 class="footer-logo"
315 alt="Zed Industries"
316 />
317 </a>
318 <span class="footer-separator">•</span>
319 <a class="footer-link" href="https://zed.dev"
320 >Back to Site</a
321 >
322 <span class="footer-separator">•</span>
323 <a
324 class="footer-link"
325 href="https://zed.dev/releases"
326 >Releases</a
327 >
328 <span class="footer-separator">•</span>
329 <a
330 class="footer-link"
331 href="https://zed.dev/roadmap"
332 >Roadmap</a
333 >
334 <span class="footer-separator">•</span>
335 <a
336 class="footer-link"
337 href="https://github.com/zed-industries/zed"
338 >GitHub</a
339 >
340 <span class="footer-separator">•</span>
341 <a
342 class="footer-link"
343 href="https://zed.dev/blog"
344 >Blog</a
345 >
346 </footer>
347 </main>
348 <div class="toc-container">
349 <nav class="pagetoc"></nav>
350 </div>
351 <!-- Immediately detect if page has headins that are not h1 to prevent flicker -->
352 <script>
353 (function() {
354 var tocContainer = document.querySelector('.toc-container');
355 var headers = document.querySelectorAll('.header');
356 var hasNonH1Headers = false;
357 for (var i = 0; i < headers.length; i++) {
358 var parent = headers[i].parentElement;
359 if (parent && !parent.tagName.toLowerCase().startsWith('h1')) {
360 hasNonH1Headers = true;
361 break;
362 }
363 }
364 if (hasNonH1Headers) {
365 tocContainer.classList.add('has-toc');
366 } else {
367 tocContainer.classList.add('no-toc');
368 }
369 })();
370 </script>
371 </div>
372 </div>
373 </div>
374
375 {{#if live_reload_endpoint}}
376 <!-- Livereload script (if served using the cli tool) -->
377 <script>
378 const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
379 const wsAddress = wsProtocol + "//" + location.host + "/" + "{{{live_reload_endpoint}}}";
380 const socket = new WebSocket(wsAddress);
381 socket.onmessage = function (event) {
382 if (event.data === "reload") {
383 socket.close();
384 location.reload();
385 }
386 };
387
388 window.onbeforeunload = function() {
389 socket.close();
390 }
391 </script>
392 {{/if}}
393
394 {{#if playground_line_numbers}}
395 <script>
396 window.playground_line_numbers = true;
397 </script>
398 {{/if}}
399
400 {{#if playground_copyable}}
401 <script>
402 window.playground_copyable = true;
403 </script>
404 {{/if}}
405
406 {{#if playground_js}}
407 <script src="{{ path_to_root }}ace.js"></script>
408 <script src="{{ path_to_root }}editor.js"></script>
409 <script src="{{ path_to_root }}mode-rust.js"></script>
410 <script src="{{ path_to_root }}theme-dawn.js"></script>
411 <script src="{{ path_to_root }}theme-tomorrow_night.js"></script>
412 {{/if}}
413
414 {{#if search_js}}
415 <script src="{{ path_to_root }}elasticlunr.min.js"></script>
416 <script src="{{ path_to_root }}mark.min.js"></script>
417 <script src="{{ path_to_root }}searcher.js"></script>
418 {{/if}}
419
420 <script src="{{ path_to_root }}clipboard.min.js"></script>
421 <script src="{{ path_to_root }}highlight.js"></script>
422 <script src="{{ path_to_root }}book.js"></script>
423
424 <!-- Custom JS scripts -->
425 {{#each additional_js}}
426 <script src="{{ ../path_to_root }}{{this}}"></script>
427 {{/each}}
428
429 {{#if is_print}}
430 {{#if mathjax_support}}
431 <script>
432 window.addEventListener('load', function() {
433 MathJax.Hub.Register.StartupHook('End', function() {
434 window.setTimeout(window.print, 100);
435 });
436 });
437 </script>
438 {{else}}
439 <script>
440 window.addEventListener('load', function() {
441 window.setTimeout(window.print, 100);
442 });
443 </script>
444 {{/if}}
445 {{/if}}
446
447 <!-- Amplitude Analytics -->
448 <script>
449 (function() {
450 var amplitudeKey = '#amplitude_key#';
451 if (amplitudeKey && amplitudeKey.indexOf('#') === -1) {
452 var script = document.createElement('script');
453 script.src = 'https://cdn.amplitude.com/script/' + amplitudeKey + '.js';
454 script.onload = function() {
455 window.amplitude.init(amplitudeKey, {
456 fetchRemoteConfig: true,
457 autocapture: true
458 });
459 };
460 document.head.appendChild(script);
461 }
462 })();
463 </script>
464 </div>
465 </body>
466</html>