This commit is contained in:
the-mikedavis 2023-01-21 20:21:15 +00:00
parent 25192ae5e8
commit 008a3a8bba
4 changed files with 68 additions and 2 deletions

View File

@ -358,6 +358,39 @@ render = true
character = "" # Some characters that work well: "", "", "", "" character = "" # Some characters that work well: "", "", "", ""
skip-levels = 1 skip-levels = 1
</code></pre> </code></pre>
<h3 id="editorgutters-section"><a class="header" href="#editorgutters-section"><code>[editor.gutters]</code> Section</a></h3>
<p>For simplicity, <code>editor.gutters</code> accepts an array of gutter types, which will
use default settings for all gutter components.</p>
<pre><code class="language-toml">[editor]
gutters = [&quot;diff&quot;, &quot;diagnostics&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;]
</code></pre>
<p>To customize the behavior of gutters, the <code>[editor.gutters]</code> section must
be used. This section contains top level settings, as well as settings for
specific gutter components as sub-sections.</p>
<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody>
<tr><td><code>layout</code></td><td>A vector of gutters to display</td><td><code>[&quot;diagnostics&quot;, &quot;spacer&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;, &quot;diff&quot;]</code></td></tr>
</tbody></table>
</div>
<p>Example:</p>
<pre><code class="language-toml">[editor.gutters]
layout = [&quot;diff&quot;, &quot;diagnostics&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;]
</code></pre>
<h4 id="editorguttersline-numbers-section"><a class="header" href="#editorguttersline-numbers-section"><code>[editor.gutters.line-numbers]</code> Section</a></h4>
<p>Options for the line number gutter</p>
<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody>
<tr><td><code>min-width</code></td><td>The minimum number of characters to use</td><td><code>3</code></td></tr>
</tbody></table>
</div>
<p>Example:</p>
<pre><code class="language-toml">[editor.gutters.line-numbers]
min-width = 1
</code></pre>
<h4 id="editorguttersdiagnotics-section"><a class="header" href="#editorguttersdiagnotics-section"><code>[editor.gutters.diagnotics]</code> Section</a></h4>
<p>Currently unused</p>
<h4 id="editorguttersdiff-section"><a class="header" href="#editorguttersdiff-section"><code>[editor.gutters.diff]</code> Section</a></h4>
<p>Currently unused</p>
<h4 id="editorguttersspacer-section"><a class="header" href="#editorguttersspacer-section"><code>[editor.gutters.spacer]</code> Section</a></h4>
<p>Currently unused</p>
</main> </main>

View File

@ -1265,6 +1265,39 @@ render = true
character = &quot;&quot; # Some characters that work well: &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot; character = &quot;&quot; # Some characters that work well: &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;
skip-levels = 1 skip-levels = 1
</code></pre> </code></pre>
<h3 id="editorgutters-section"><a class="header" href="#editorgutters-section"><code>[editor.gutters]</code> Section</a></h3>
<p>For simplicity, <code>editor.gutters</code> accepts an array of gutter types, which will
use default settings for all gutter components.</p>
<pre><code class="language-toml">[editor]
gutters = [&quot;diff&quot;, &quot;diagnostics&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;]
</code></pre>
<p>To customize the behavior of gutters, the <code>[editor.gutters]</code> section must
be used. This section contains top level settings, as well as settings for
specific gutter components as sub-sections.</p>
<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody>
<tr><td><code>layout</code></td><td>A vector of gutters to display</td><td><code>[&quot;diagnostics&quot;, &quot;spacer&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;, &quot;diff&quot;]</code></td></tr>
</tbody></table>
</div>
<p>Example:</p>
<pre><code class="language-toml">[editor.gutters]
layout = [&quot;diff&quot;, &quot;diagnostics&quot;, &quot;line-numbers&quot;, &quot;spacer&quot;]
</code></pre>
<h4 id="editorguttersline-numbers-section"><a class="header" href="#editorguttersline-numbers-section"><code>[editor.gutters.line-numbers]</code> Section</a></h4>
<p>Options for the line number gutter</p>
<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody>
<tr><td><code>min-width</code></td><td>The minimum number of characters to use</td><td><code>3</code></td></tr>
</tbody></table>
</div>
<p>Example:</p>
<pre><code class="language-toml">[editor.gutters.line-numbers]
min-width = 1
</code></pre>
<h4 id="editorguttersdiagnotics-section"><a class="header" href="#editorguttersdiagnotics-section"><code>[editor.gutters.diagnotics]</code> Section</a></h4>
<p>Currently unused</p>
<h4 id="editorguttersdiff-section"><a class="header" href="#editorguttersdiff-section"><code>[editor.gutters.diff]</code> Section</a></h4>
<p>Currently unused</p>
<h4 id="editorguttersspacer-section"><a class="header" href="#editorguttersspacer-section"><code>[editor.gutters.spacer]</code> Section</a></h4>
<p>Currently unused</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="themes"><a class="header" href="#themes">Themes</a></h1> <div style="break-before: page; page-break-before: always;"></div><h1 id="themes"><a class="header" href="#themes">Themes</a></h1>
<p>To use a theme add <code>theme = &quot;&lt;name&gt;&quot;</code> to your <a href="./configuration.html"><code>config.toml</code></a> at the very top of the file before the first section or select it during runtime using <code>:theme &lt;name&gt;</code>.</p> <p>To use a theme add <code>theme = &quot;&lt;name&gt;&quot;</code> to your <a href="./configuration.html"><code>config.toml</code></a> at the very top of the file before the first section or select it during runtime using <code>:theme &lt;name&gt;</code>.</p>
<h2 id="creating-a-theme"><a class="header" href="#creating-a-theme">Creating a theme</a></h2> <h2 id="creating-a-theme"><a class="header" href="#creating-a-theme">Creating a theme</a></h2>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long