Skip to content

Commit b8f674b

Browse files
Deploying to gh-pages from @ ceea755 🚀
1 parent 0ca85d6 commit b8f674b

11 files changed

+12
-12
lines changed

404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</head>
1717
<body>
1818
<div id="app"></div>
19-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"CMvdPm4U\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
19+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"DGPQGdvJ\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
2020

2121
</body>
2222
</html>

assets/configuration.md.CMvdPm4U.js renamed to assets/configuration.md.DGPQGdvJ.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

configuration.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

contributing.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

hashmap.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"configuration.md":"CMvdPm4U","contributing.md":"CdibYapP","index.md":"OAD0xRP3","installation.md":"BN1psEnH","plugins.md":"BxfkztMV","troubleshoot.md":"BJoQcACB","tutorial.md":"DWici8EJ"}
1+
{"configuration.md":"DGPQGdvJ","contributing.md":"CdibYapP","index.md":"OAD0xRP3","installation.md":"BN1psEnH","plugins.md":"BxfkztMV","troubleshoot.md":"BJoQcACB","tutorial.md":"DWici8EJ"}

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> })</span></span>
3030
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> end</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
3131
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></li><li><p>Capture youf first note with <code>&lt;leader&gt;oc</code></p></li><li><p>Open up the prompt for agenda with <code>&lt;leader&gt;oa</code></p></li></ul><p>For more details about the installation and usage, check <a href="./installation">Installation_page</a>.</p><p>To see all configuration options, check <a href="./configuration">Configuration_page</a>.</p><h2 id="getting-started with orgmode" tabindex="-1">Getting started with orgmode <a class="header-anchor" href="#getting-started with orgmode" aria-label="Permalink to &quot;Getting started with orgmode&quot;"></a></h2><p>To get a basic idea how Orgmode works, check our hands-on <a href="./tutorial">tutorial</a>.</p><p>You can also check this screencast from <a href="https://github.com/dhruvasagar" target="_blank" rel="noreferrer">@dhruvasagar</a> that demonstrates how the similar Orgmode clone <a href="https://github.com/dhruvasagar/vim-dotoo" target="_blank" rel="noreferrer">vim-dotoo</a> works.</p><p><a href="https://www.youtube.com/watch?v=nsv33iOnH34" target="_blank" rel="noreferrer">https://www.youtube.com/watch?v=nsv33iOnH34</a></p><h2 id="api-docs" tabindex="-1">API docs <a class="header-anchor" href="#api-docs" aria-label="Permalink to &quot;API docs&quot;"></a></h2><p>Nvim-orgmode exposes a Lua API that can be used to interact with the orgmode. To view it, check <a href="../docs/orgmode-api.txt">orgmode-api.txt</a> or do <code>:h OrgApi</code> in Neovim.</p><h2 id="globals-and commands" tabindex="-1">Globals and commands <a class="header-anchor" href="#globals-and commands" aria-label="Permalink to &quot;Globals and commands&quot;"></a></h2><p>There are 2 additional ways to interact with Orgmode:</p><ol><li>Through the <code>:Org</code> command</li><li>Through <code>Org</code> Lua global variable</li></ol><p>List of available actions:</p><ul><li><code>:Org help</code> - Open this documentation in new tab, set working directory to the docs folder for the tab to allow browsing</li><li><code>:Org helpgrep</code> - Open search agenda view that allows searching through the documentation</li><li><code>:Org agenda {type?}</code> - Open agenda view by the shortcut, for example <code>:Org agenda M</code> will open <code>tags_todo</code> view. When <code>type</code> is omitted, it opens up Agenda view.</li><li><code>:Org capture {type?}</code> - Open capture template by the shortcut, for example <code>:Org capture t</code>. When <code>type</code> is omitted, it opens up Capture prompt.</li><li><code>:Org install_treesitter_grammar</code> - Install the treesitter grammar for Orgmode. If installed, prompt to reinstall. Grammar is installed automatically on first run, but this is useful in case when there are issues with the grammar.</li></ul><p>All of the commands above can be executed through the global Lua <code>Org</code> variable. Examples:</p><ul><li><code>Org.help()</code></li><li><code>Org.helpgrep()</code></li><li><code>Org.install_treesitter_grammar()</code></li><li><code>Org.agenda()</code> - Opens <code>agenda</code> prompt</li><li><code>Org.agenda.m()</code> - Opens <code>tags</code> view</li><li><code>Org.capture()</code> - Opens capture prompt</li><li><code>Org.capture.t()</code> - Opens capture template for <code>t</code> shortcut</li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><!----></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/index" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Home</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
32-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"CMvdPm4U\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
32+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"DGPQGdvJ\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
3333

3434
</body>
3535
</html>

installation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> org_default_notes_file </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;~/orgfiles/refile.org&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
5353
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> })</span></span>
5454
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> EOF</span></span></code></pre></div></li></ol><h3 id="useful-links:" tabindex="-1">Useful links: <a class="header-anchor" href="#useful-links:" aria-label="Permalink to &quot;Useful links:&quot;"></a></h3><ul><li><a href="./configuration">Configuration</a></li><li><a href="./plugins">Plugins</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/index" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>Home</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/configuration" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Configuration</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
55-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"CMvdPm4U\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
55+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"DGPQGdvJ\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
5656

5757
</body>
5858
</html>

plugins.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> vim.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">keymap</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">set</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;n&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;&lt;leader&gt;li&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">require</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;telescope&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">extensions</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">orgmode</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">insert_link</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
8181
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> end</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
8282
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/configuration" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>Configuration</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/contributing" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Contributing</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
83-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"CMvdPm4U\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
83+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"configuration.md\":\"DGPQGdvJ\",\"contributing.md\":\"CdibYapP\",\"index.md\":\"OAD0xRP3\",\"installation.md\":\"BN1psEnH\",\"plugins.md\":\"BxfkztMV\",\"troubleshoot.md\":\"BJoQcACB\",\"tutorial.md\":\"DWici8EJ\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Nvim Orgmode\",\"description\":\"Documentation for Nvim Orgmode\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Installation\",\"link\":\"/installation\"},{\"text\":\"Configuration\",\"link\":\"/configuration\"},{\"text\":\"Plugins\",\"link\":\"/plugins\"},{\"text\":\"Contributing\",\"link\":\"/contributing\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Tutorial\",\"link\":\"/tutorial\"}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/nvim-orgmode/orgmode\"}],\"outline\":{\"level\":[2,3]}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
8484

8585
</body>
8686
</html>

0 commit comments

Comments
 (0)