diff options
Diffstat (limited to '23.10.1/guides/injection.html')
| -rw-r--r-- | 23.10.1/guides/injection.html | 298 |
1 files changed, 0 insertions, 298 deletions
diff --git a/23.10.1/guides/injection.html b/23.10.1/guides/injection.html deleted file mode 100644 index fb4bb8f3..00000000 --- a/23.10.1/guides/injection.html +++ /dev/null @@ -1,298 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding injection queries</title> - - - <!-- Custom HTML head --> - - <meta name="description" content=""> - <meta name="viewport" content="width=device-width, initial-scale=1"> - <meta name="theme-color" content="#ffffff"> - - <link rel="icon" href="../favicon.svg"> - <link rel="shortcut icon" href="../favicon.png"> - <link rel="stylesheet" href="../css/variables.css"> - <link rel="stylesheet" href="../css/general.css"> - <link rel="stylesheet" href="../css/chrome.css"> - <link rel="stylesheet" href="../css/print.css" media="print"> - - <!-- Fonts --> - <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css"> - <link rel="stylesheet" href="../fonts/fonts.css"> - - <!-- Highlight.js Stylesheets --> - <link rel="stylesheet" href="../highlight.css"> - <link rel="stylesheet" href="../tomorrow-night.css"> - <link rel="stylesheet" href="../ayu-highlight.css"> - - <!-- Custom theme stylesheets --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - var path_to_root = "../"; - var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "colibri" : "colibri"; - </script> - - <!-- Work around some values being stored in localStorage wrapped in quotes --> - <script> - try { - var theme = localStorage.getItem('mdbook-theme'); - var sidebar = localStorage.getItem('mdbook-sidebar'); - - if (theme.startsWith('"') && theme.endsWith('"')) { - localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); - } - - if (sidebar.startsWith('"') && sidebar.endsWith('"')) { - localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); - } - } catch (e) { } - </script> - - <!-- Set the theme before any content is loaded, prevents flash --> - <script> - var theme; - try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } - if (theme === null || theme === undefined) { theme = default_theme; } - var html = document.querySelector('html'); - html.classList.remove('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.classList.add("sidebar-" + sidebar); - </script> - - <nav id="sidebar" class="sidebar" aria-label="Table of contents"> - <div class="sidebar-scrollbox"> - <ol class="chapter"><li class="chapter-item expanded affix "><a href="../title-page.html">Helix</a></li><li class="chapter-item expanded "><a href="../install.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="../usage.html"><strong aria-hidden="true">2.</strong> Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../keymap.html"><strong aria-hidden="true">2.1.</strong> Keymap</a></li><li class="chapter-item expanded "><a href="../commands.html"><strong aria-hidden="true">2.2.</strong> Commands</a></li><li class="chapter-item expanded "><a href="../lang-support.html"><strong aria-hidden="true">2.3.</strong> Language support</a></li></ol></li><li class="chapter-item expanded "><a href="../from-vim.html"><strong aria-hidden="true">3.</strong> Migrating from Vim</a></li><li class="chapter-item expanded "><a href="../configuration.html"><strong aria-hidden="true">4.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../themes.html"><strong aria-hidden="true">4.1.</strong> Themes</a></li><li class="chapter-item expanded "><a href="../remapping.html"><strong aria-hidden="true">4.2.</strong> Key remapping</a></li><li class="chapter-item expanded "><a href="../languages.html"><strong aria-hidden="true">4.3.</strong> Languages</a></li></ol></li><li class="chapter-item expanded "><a href="../guides/index.html"><strong aria-hidden="true">5.</strong> Guides</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../guides/adding_languages.html"><strong aria-hidden="true">5.1.</strong> Adding languages</a></li><li class="chapter-item expanded "><a href="../guides/textobject.html"><strong aria-hidden="true">5.2.</strong> Adding textobject queries</a></li><li class="chapter-item expanded "><a href="../guides/indent.html"><strong aria-hidden="true">5.3.</strong> Adding indent queries</a></li><li class="chapter-item expanded "><a href="../guides/injection.html" class="active"><strong aria-hidden="true">5.4.</strong> Adding injection queries</a></li><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <div id="page-wrapper" class="page-wrapper"> - - <div class="page"> - <div id="menu-bar-hover-placeholder"></div> - <div id="menu-bar" class="menu-bar sticky"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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"> - <i class="fa fa-paint-brush"></i> - </button> - <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> - <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> - <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> - <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> - <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> - <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> - <li role="none"><button role="menuitem" class="theme" id="colibri">Colibri</button></li> - </ul> - <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> - <i class="fa fa-search"></i> - </button> - </div> - - <h1 class="menu-title"></h1> - - <div class="right-buttons"> - <a href="../print.html" title="Print this book" aria-label="Print this book"> - <i id="print-button" class="fa fa-print"></i> - </a> - <a href="https://github.com/helix-editor/helix" title="Git repository" aria-label="Git repository"> - <i id="git-repository-button" class="fa fa-github"></i> - </a> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/injection.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> - </form> - <div id="searchresults-outer" class="searchresults-outer hidden"> - <div id="searchresults-header" class="searchresults-header"></div> - <ul id="searchresults"> - </ul> - </div> - </div> - - <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> - <script> - document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); - document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); - Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { - link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); - }); - </script> - - <div id="content" class="content"> - <main> - <h1 id="adding-injection-queries"><a class="header" href="#adding-injection-queries">Adding Injection Queries</a></h1> -<p>Writing language injection queries allows one to highlight a specific node as a different language. -In addition to the <a href="http://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection">standard</a> language injection options used by tree-sitter, there -are a few Helix specific extensions that allow for more control.</p> -<p>And example of a simple query that would highlight all strings as bash in Nix:</p> -<pre><code class="language-scm">((string_expression (string_fragment) @injection.content) - (#set! injection.language "bash")) -</code></pre> -<h2 id="capture-types"><a class="header" href="#capture-types">Capture Types</a></h2> -<ul> -<li> -<p><code>@injection.language</code> (standard): -The captured node may contain the language name used to highlight the node captured by -<code>@injection.content</code>.</p> -</li> -<li> -<p><code>@injection.content</code> (standard): -Marks the content to be highlighted as the language captured with <code>@injection.language</code> <em>et al</em>.</p> -</li> -<li> -<p><code>@injection.filename</code> (extension): -The captured node may contain a filename with a file-extension known to Helix, -highlighting <code>@injection.content</code> as that language. This uses the language extensions defined in -both the default languages.toml distributed with Helix, as well as user defined languages.</p> -</li> -<li> -<p><code>@injection.shebang</code> (extension): -The captured node may contain a shebang used to choose a language to highlight as. This also uses -the shebangs defined in the default and user <code>languages.toml</code>.</p> -</li> -</ul> -<h2 id="settings"><a class="header" href="#settings">Settings</a></h2> -<ul> -<li> -<p><code>injection.combined</code> (standard): -Indicates that all the matching nodes in the tree should have their content parsed as one -nested document.</p> -</li> -<li> -<p><code>injection.language</code> (standard): -Forces the captured content to be highlighted as the given language</p> -</li> -<li> -<p><code>injection.include-children</code> (standard): -Indicates that the content node’s entire text should be re-parsed, including the text of its child -nodes. By default, child nodes’ text will be excluded from the injected document.</p> -</li> -<li> -<p><code>injection.include-unnamed-children</code> (extension): -Same as <code>injection.include-children</code> but only for unnamed child nodes.</p> -</li> -</ul> -<h2 id="predicates"><a class="header" href="#predicates">Predicates</a></h2> -<ul> -<li> -<p><code>#eq?</code> (standard): -The first argument (a capture) must be equal to the second argument -(a capture or a string).</p> -</li> -<li> -<p><code>#match?</code> (standard): -The first argument (a capture) must match the regex given in the -second argument (a string).</p> -</li> -</ul> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../guides/indent.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> - <i class="fa fa-angle-left"></i> - </a> - - <a rel="next prefetch" href="../guides/rainbow_bracket_queries.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> - <i class="fa fa-angle-right"></i> - </a> - - <div style="clear: both"></div> - </nav> - </div> - </div> - - <nav class="nav-wide-wrapper" aria-label="Page navigation"> - <a rel="prev" href="../guides/indent.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> - <i class="fa fa-angle-left"></i> - </a> - - <a rel="next prefetch" href="../guides/rainbow_bracket_queries.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> - <i class="fa fa-angle-right"></i> - </a> - </nav> - - </div> - - - - - <script> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> |