Skip to content

Commit ecedcd5

Browse files
committed
Deploy website
Deploy website version based on 56987aac60e2e42823cb55f0f555d25312837dc6
1 parent a770bef commit ecedcd5

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

docs/configuration/settings.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ <h3><a class="anchor" aria-hidden="true" id="editor"></a><a href="#editor" aria-
120120
<li><p><code>editor.wordBasedSuggestions</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> When <code>true</code>, keywords are provided as completion suggestions.</p></li>
121121
<li><p><code>editor.wordWrap</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> When <code>true</code>, Onivim will soft-wrap lines at the viewport boundary.</p></li>
122122
<li><p><code>editor.rulers</code> <strong>(<em>list of int</em> default: <code>[]</code>)</strong> - Render vertical rulers at given columns.</p></li>
123-
<li><p><code>explorer.autoReveal</code> <strong>(<em>string|bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the file explorer will jump to highlight the file current focused. When <code>false</code> the file explorer will remain static. If a string is entered it must be <code>&quot;focusNoScroll&quot;</code> which will still highlight the currently focused file in the file explorer but the file explorer will not scroll to it. Any other string supplied will be treated as if <code>false</code> was entered and the file explorer will remain static and not highlight the currently focused file.</p></li>
124123
<li><p><code>editor.scrollShadow</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, show a drop-shadow effect at the borders when there is additional content past the visible area.</p></li>
125124
<li><p><code>editor.smoothScroll</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, smoothly scroll the editor when the viewport is adjusted due to a cursor motion.</p></li>
126125
<li><p><code>editor.zenMode.singleFile</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the Onivim will automatically enter zen mode when started up with a single file. Zen mode hides most of the UI until disabled via the command pallette.</p></li>
@@ -139,6 +138,11 @@ <h3><a class="anchor" aria-hidden="true" id="input"></a><a href="#input" aria-hi
139138
<li><p><code>vim.leader</code> <strong>(<em>string</em>)</strong> - Specify a custom <a href="./key-bindings#leader-key">leader key</a>.</p></li>
140139
<li><p><code>vim.timeout</code> <strong>(<em>int</em> default: <code>1000</code>)</strong> Sets the timeout, in milliseconds, when Onivim is waiting for a pending chord. When the timeout is reached, any pending keys that are partially mapped will be flushed. Equivalent to the <code>timeoutlen</code> Vim setting. Can be set to <code>0</code> to disable the timeout entirely.</p></li>
141140
</ul>
141+
<h3><a class="anchor" aria-hidden="true" id="explorer"></a><a href="#explorer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Explorer</h3>
142+
<ul>
143+
<li><p><code>explorer.autoReveal</code> <strong>(<em>string|bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the file explorer will jump to highlight the file current focused. When <code>false</code> the file explorer will remain static. If a string is entered it must be <code>&quot;focusNoScroll&quot;</code> which will still highlight the currently focused file in the file explorer but the file explorer will not scroll to it. Any other string supplied will be treated as if <code>false</code> was entered and the file explorer will remain static and not highlight the currently focused file.</p></li>
144+
<li><p><code>files.useExperimentalFileWatcher</code> <strong>(<em>bool</em> default: <code>false</code>)</strong> When <code>true</code>, a file watcher will be used to monitor file system changes and update the explorer in the sidebar.</p></li>
145+
</ul>
142146
<h3><a class="anchor" aria-hidden="true" id="layout"></a><a href="#layout" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Layout</h3>
143147
<ul>
144148
<li><p><code>workbench.editor.showTabs</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>false</code>, hides the editor tabs.</p></li>
@@ -202,4 +206,4 @@ <h2><a class="anchor" aria-hidden="true" id="language-specific-configuration"></
202206
}
203207
</code></pre>
204208
<p>In the above example, the <code>editor.insertSpaces</code> value of <code>false</code> in the <code>reason</code> section overrides the default of <code>true</code> - this configures the editor to use tabs in reason files for indentation, and spaces elsewhere.</p>
205-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/using-onivim/snippets"><span class="arrow-prev"></span><span>Snippets</span></a><a class="docs-next button" href="/docs/configuration/key-bindings"><span>Key Bindings</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#editing-the-user-settings">Editing the user settings</a><ul class="toc-headings"><li><a href="#directly-editing-the-user-settings">Directly editing the user settings</a></li></ul></li><li><a href="#configuration-settings">Configuration Settings</a><ul class="toc-headings"><li><a href="#editor">Editor</a></li><li><a href="#input">Input</a></li><li><a href="#layout">Layout</a></li><li><a href="#rendering">Rendering</a></li><li><a href="#ui">UI</a></li><li><a href="#vim">Vim</a></li><li><a href="#high-dpi--ui-scaling">High-DPI / UI Scaling</a></li><li><a href="#experimental">Experimental</a></li></ul></li><li><a href="#language-specific-configuration">Language-specific configuration</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home" style="opacity:0"><img src="/img/logo2.png" alt="Onivim 2 User Manual" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/getting-started/why-onivim">Getting Started</a><a href="/docs/using-onivim/moving-in-onivim">Basic Usage</a><a href="/docs/for-developers/building">For Developers</a><a href="/docs/other/faq">FAQ</a></div><div><h5>Community</h5><a href="https://reddit.com/r/onivim">Reddit</a><a href="https://discord.gg/7maEAxV">Discord</a><a href="https://twitter.com/oni_vim" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="https://github.com/onivim/oni2">GitHub</a><a class="github-button" href="https://github.com/onivim/oni2" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Outrun Labs, LLC</section></footer></div></body></html>
209+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/using-onivim/snippets"><span class="arrow-prev"></span><span>Snippets</span></a><a class="docs-next button" href="/docs/configuration/key-bindings"><span>Key Bindings</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#editing-the-user-settings">Editing the user settings</a><ul class="toc-headings"><li><a href="#directly-editing-the-user-settings">Directly editing the user settings</a></li></ul></li><li><a href="#configuration-settings">Configuration Settings</a><ul class="toc-headings"><li><a href="#editor">Editor</a></li><li><a href="#input">Input</a></li><li><a href="#explorer">Explorer</a></li><li><a href="#layout">Layout</a></li><li><a href="#rendering">Rendering</a></li><li><a href="#ui">UI</a></li><li><a href="#vim">Vim</a></li><li><a href="#high-dpi--ui-scaling">High-DPI / UI Scaling</a></li><li><a href="#experimental">Experimental</a></li></ul></li><li><a href="#language-specific-configuration">Language-specific configuration</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home" style="opacity:0"><img src="/img/logo2.png" alt="Onivim 2 User Manual" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/getting-started/why-onivim">Getting Started</a><a href="/docs/using-onivim/moving-in-onivim">Basic Usage</a><a href="/docs/for-developers/building">For Developers</a><a href="/docs/other/faq">FAQ</a></div><div><h5>Community</h5><a href="https://reddit.com/r/onivim">Reddit</a><a href="https://discord.gg/7maEAxV">Discord</a><a href="https://twitter.com/oni_vim" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="https://github.com/onivim/oni2">GitHub</a><a class="github-button" href="https://github.com/onivim/oni2" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Outrun Labs, LLC</section></footer></div></body></html>

docs/configuration/settings/index.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ <h3><a class="anchor" aria-hidden="true" id="editor"></a><a href="#editor" aria-
120120
<li><p><code>editor.wordBasedSuggestions</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> When <code>true</code>, keywords are provided as completion suggestions.</p></li>
121121
<li><p><code>editor.wordWrap</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> When <code>true</code>, Onivim will soft-wrap lines at the viewport boundary.</p></li>
122122
<li><p><code>editor.rulers</code> <strong>(<em>list of int</em> default: <code>[]</code>)</strong> - Render vertical rulers at given columns.</p></li>
123-
<li><p><code>explorer.autoReveal</code> <strong>(<em>string|bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the file explorer will jump to highlight the file current focused. When <code>false</code> the file explorer will remain static. If a string is entered it must be <code>&quot;focusNoScroll&quot;</code> which will still highlight the currently focused file in the file explorer but the file explorer will not scroll to it. Any other string supplied will be treated as if <code>false</code> was entered and the file explorer will remain static and not highlight the currently focused file.</p></li>
124123
<li><p><code>editor.scrollShadow</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, show a drop-shadow effect at the borders when there is additional content past the visible area.</p></li>
125124
<li><p><code>editor.smoothScroll</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, smoothly scroll the editor when the viewport is adjusted due to a cursor motion.</p></li>
126125
<li><p><code>editor.zenMode.singleFile</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the Onivim will automatically enter zen mode when started up with a single file. Zen mode hides most of the UI until disabled via the command pallette.</p></li>
@@ -139,6 +138,11 @@ <h3><a class="anchor" aria-hidden="true" id="input"></a><a href="#input" aria-hi
139138
<li><p><code>vim.leader</code> <strong>(<em>string</em>)</strong> - Specify a custom <a href="./key-bindings#leader-key">leader key</a>.</p></li>
140139
<li><p><code>vim.timeout</code> <strong>(<em>int</em> default: <code>1000</code>)</strong> Sets the timeout, in milliseconds, when Onivim is waiting for a pending chord. When the timeout is reached, any pending keys that are partially mapped will be flushed. Equivalent to the <code>timeoutlen</code> Vim setting. Can be set to <code>0</code> to disable the timeout entirely.</p></li>
141140
</ul>
141+
<h3><a class="anchor" aria-hidden="true" id="explorer"></a><a href="#explorer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Explorer</h3>
142+
<ul>
143+
<li><p><code>explorer.autoReveal</code> <strong>(<em>string|bool</em> default: <code>true</code>)</strong> - When <code>true</code>, the file explorer will jump to highlight the file current focused. When <code>false</code> the file explorer will remain static. If a string is entered it must be <code>&quot;focusNoScroll&quot;</code> which will still highlight the currently focused file in the file explorer but the file explorer will not scroll to it. Any other string supplied will be treated as if <code>false</code> was entered and the file explorer will remain static and not highlight the currently focused file.</p></li>
144+
<li><p><code>files.useExperimentalFileWatcher</code> <strong>(<em>bool</em> default: <code>false</code>)</strong> When <code>true</code>, a file watcher will be used to monitor file system changes and update the explorer in the sidebar.</p></li>
145+
</ul>
142146
<h3><a class="anchor" aria-hidden="true" id="layout"></a><a href="#layout" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Layout</h3>
143147
<ul>
144148
<li><p><code>workbench.editor.showTabs</code> <strong>(<em>bool</em> default: <code>true</code>)</strong> - When <code>false</code>, hides the editor tabs.</p></li>
@@ -202,4 +206,4 @@ <h2><a class="anchor" aria-hidden="true" id="language-specific-configuration"></
202206
}
203207
</code></pre>
204208
<p>In the above example, the <code>editor.insertSpaces</code> value of <code>false</code> in the <code>reason</code> section overrides the default of <code>true</code> - this configures the editor to use tabs in reason files for indentation, and spaces elsewhere.</p>
205-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/using-onivim/snippets"><span class="arrow-prev"></span><span>Snippets</span></a><a class="docs-next button" href="/docs/configuration/key-bindings"><span>Key Bindings</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#editing-the-user-settings">Editing the user settings</a><ul class="toc-headings"><li><a href="#directly-editing-the-user-settings">Directly editing the user settings</a></li></ul></li><li><a href="#configuration-settings">Configuration Settings</a><ul class="toc-headings"><li><a href="#editor">Editor</a></li><li><a href="#input">Input</a></li><li><a href="#layout">Layout</a></li><li><a href="#rendering">Rendering</a></li><li><a href="#ui">UI</a></li><li><a href="#vim">Vim</a></li><li><a href="#high-dpi--ui-scaling">High-DPI / UI Scaling</a></li><li><a href="#experimental">Experimental</a></li></ul></li><li><a href="#language-specific-configuration">Language-specific configuration</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home" style="opacity:0"><img src="/img/logo2.png" alt="Onivim 2 User Manual" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/getting-started/why-onivim">Getting Started</a><a href="/docs/using-onivim/moving-in-onivim">Basic Usage</a><a href="/docs/for-developers/building">For Developers</a><a href="/docs/other/faq">FAQ</a></div><div><h5>Community</h5><a href="https://reddit.com/r/onivim">Reddit</a><a href="https://discord.gg/7maEAxV">Discord</a><a href="https://twitter.com/oni_vim" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="https://github.com/onivim/oni2">GitHub</a><a class="github-button" href="https://github.com/onivim/oni2" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Outrun Labs, LLC</section></footer></div></body></html>
209+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/using-onivim/snippets"><span class="arrow-prev"></span><span>Snippets</span></a><a class="docs-next button" href="/docs/configuration/key-bindings"><span>Key Bindings</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#editing-the-user-settings">Editing the user settings</a><ul class="toc-headings"><li><a href="#directly-editing-the-user-settings">Directly editing the user settings</a></li></ul></li><li><a href="#configuration-settings">Configuration Settings</a><ul class="toc-headings"><li><a href="#editor">Editor</a></li><li><a href="#input">Input</a></li><li><a href="#explorer">Explorer</a></li><li><a href="#layout">Layout</a></li><li><a href="#rendering">Rendering</a></li><li><a href="#ui">UI</a></li><li><a href="#vim">Vim</a></li><li><a href="#high-dpi--ui-scaling">High-DPI / UI Scaling</a></li><li><a href="#experimental">Experimental</a></li></ul></li><li><a href="#language-specific-configuration">Language-specific configuration</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home" style="opacity:0"><img src="/img/logo2.png" alt="Onivim 2 User Manual" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/getting-started/why-onivim">Getting Started</a><a href="/docs/using-onivim/moving-in-onivim">Basic Usage</a><a href="/docs/for-developers/building">For Developers</a><a href="/docs/other/faq">FAQ</a></div><div><h5>Community</h5><a href="https://reddit.com/r/onivim">Reddit</a><a href="https://discord.gg/7maEAxV">Discord</a><a href="https://twitter.com/oni_vim" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="https://github.com/onivim/oni2">GitHub</a><a class="github-button" href="https://github.com/onivim/oni2" data-icon="octicon-star" data-count-href="/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2021 Outrun Labs, LLC</section></footer></div></body></html>

0 commit comments

Comments
 (0)