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