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