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