Ocelot-Social/assets/documentation.html-OXRtZK5T.js

import{_ as e}from"./plugin-vue_export-helper-DlAUqK2U.js";import{c as s,a,o as n}from"./app-42vVvAb-.js";const t={};function o(h,i){return n(),s("div",null,i[0]||(i[0]=[a(`<h1 id="documentation" tabindex="-1"><a class="header-anchor" href="#documentation"><span>Documentation</span></a></h1><h2 id="edit-this-documentation" tabindex="-1"><a class="header-anchor" href="#edit-this-documentation"><span>Edit this Documentation</span></a></h2><p>Find the <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/SUMMARY.md" target="_blank" rel="noopener noreferrer"><strong>table of contents</strong> for this documentation on GitHub</a> and navigate to the file you need to update.</p><p>Click on the <strong>edit pencil</strong> on the right side directly above the text to edit this file in our repository.</p><p>You can see a preview of your changes by clicking the <strong>Preview changes</strong> tab aside the <strong>Edit file</strong> tab.</p><p>If you are ready, fill in the <strong>Propose file change</strong> at the end of the webpage.</p><p>After that you have to compare your change branch to our <code>master</code> branch with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/issues" target="_blank" rel="noopener noreferrer">open issues</a> please include the number.)</p><h3 id="markdown-your-documentation" tabindex="-1"><a class="header-anchor" href="#markdown-your-documentation"><span>Markdown your documentation</span></a></h3><p>To design your documentation see the syntax description at GitBook:</p><p><a href="https://toolchain.gitbook.com/syntax/markdown.html" target="_blank" rel="noopener noreferrer">https://toolchain.gitbook.com/syntax/markdown.html</a></p><h4 id="some-quick-examples" tabindex="-1"><a class="header-anchor" href="#some-quick-examples"><span>Some quick Examples</span></a></h4><h5 id="headlines" tabindex="-1"><a class="header-anchor" href="#headlines"><span>Headlines</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#E45649;--shiki-dark:#E06C75;"># Main Headline</span></span>
<span class="line"><span style="--shiki-light:#E45649;--shiki-dark:#E06C75;">## Smaller Headlines</span></span>
<span class="line"><span style="--shiki-light:#E45649;--shiki-dark:#E06C75;">### Small Headlines</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="tabs" tabindex="-1"><a class="header-anchor" href="#tabs"><span>Tabs</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">::: tabs</span></span>
<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">@tab:active First tab&#39;s title </span><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;">&lt;!-- this tab is setactive --&gt;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">@tab Second tab&#39;s title</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">:::</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="commands" tabindex="-1"><a class="header-anchor" href="#commands"><span>Commands</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">\`\`\`&lt;LANGUAGE&gt; (for text highlighting)</span></span>
<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">XXX</span></span>
<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">\`\`\`</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h5 id="links" tabindex="-1"><a class="header-anchor" href="#links"><span>Links</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#986801;--shiki-dark:#ABB2BF;">[</span><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">XXX</span><span style="--shiki-light:#986801;--shiki-dark:#ABB2BF;">]</span><span style="--shiki-light:#A626A4;--shiki-dark:#E06C75;">(</span><span style="--shiki-light:#A626A4;--shiki-light-text-decoration:inherit;--shiki-dark:#C678DD;--shiki-dark-text-decoration:underline;">https://XXX</span><span style="--shiki-light:#A626A4;--shiki-dark:#E06C75;">)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>For the documentation to work in both frameworks - Github and Vuepress - please use absolute path for Github internal documentation links (e.g. /README.md over ../../README.mdetc.)</p><h5 id="screenshots-or-other-images" tabindex="-1"><a class="header-anchor" href="#screenshots-or-other-images"><span>Screenshots or other Images</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">![</span><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">XXX</span><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">]</span><span style="--shiki-light:#A626A4;--shiki-dark:#E06C75;">(</span><span style="--shiki-light:#A626A4;--shiki-light-text-decoration:inherit;--shiki-dark:#C678DD;--shiki-dark-text-decoration:underline;">https://XXX</span><span style="--shiki-light:#A626A4;--shiki-dark:#E06C75;">)</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h5 id="hints-for-todos" tabindex="-1"><a class="header-anchor" href="#hints-for-todos"><span>Hints for ToDos</span></a></h5><div class="language-markdown line-numbers-mode" data-highlighter="shiki" data-ext="markdown" data-title="markdown" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">{% hint style=&quot;info&quot; %} TODO: XXX {% endhint %}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="host-the-screenshots" tabindex="-1"><a class="header-anchor" href="#host-the-screenshots"><span>Host the Screenshots</span></a></h3><h4 id="host-on-ocelot-social-github-repository" tabindex="-1"><a class="header-anchor" href="#host-on-ocelot-social-github-repository"><span>Host on Ocelot-Social (GitHub) Repository</span></a></h4><p>{% hint style=&quot;info&quot; %} TODO: How to host on Ocelot-Social (GitHub) repository ... {% endhint %}</p><h4 id="quick-solution" tabindex="-1"><a class="header-anchor" href="#quick-solution"><span>Quick Solution</span></a></h4><p>To quickly host the screenshots go to:</p><p><a href="https://imgur.com" target="_blank" rel="noopener noreferrer">https://imgur.com</a>.</p><p>There click the green button <strong>New post</strong>.</p><p>Drag the image into the appropriate area.</p><p>Right click on it and choose kind of <strong>Open link in new tab</strong>.</p><p>Copy the URL and paste it were you need it.</p><h3 id="screenshot-modification" tabindex="-1"><a class="header-anchor" href="#screenshot-modification"><span>Screenshot Modification</span></a></h3><h4 id="add-an-arrow-or-some-other-marking-stuff" tabindex="-1"><a class="header-anchor" href="#add-an-arrow-or-some-other-marking-stuff"><span>Add an Arrow or some other Marking Stuff</span></a></h4><p>::: tabs @tab:active macOS</p><h5 id="in-the-preview-app" tabindex="-1"><a class="header-anchor" href="#in-the-preview-app"><span>In the Preview App</span></a></h5><p>Got to: <strong>Menu</strong> + <strong>Tools</strong> (GER: Werkzeuge) + <strong>Annotate</strong> (GER: Anmerkungen) + etc.</p><p>@tab Windows</p><p>{% hint style=&quot;info&quot; %} TODO: How to modify screenshots in Windows ... {% endhint %} {% endtab %}</p><p>@tab Linux {% hint style=&quot;info&quot; %} TODO: How to modify screenshots in Linux ... {% endhint %} :::</p><h2 id="deploy-this-documentation" tabindex="-1"><a class="header-anchor" href="#deploy-this-documentation"><span>Deploy this Documentation</span></a></h2><p>TODO</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" data-title="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code><span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># set configured Node version</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">nvm</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> use</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># install Vuepress</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">npm</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> install</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#A0A1A7;--shiki-light-font-style:italic;--shiki-dark:#7F848E;--shiki-dark-font-style:italic;"># run vuepress</span></span>
<span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">npm</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> docs:dev</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,45)]))}const d=e(t,[["render",o],["__file","documentation.html.vue"]]),c=JSON.parse('{"path":"/documentation.html","title":"Documentation","lang":"en-US","frontmatter":{},"headers":[{"level":2,"title":"Edit this Documentation","slug":"edit-this-documentation","link":"#edit-this-documentation","children":[{"level":3,"title":"Markdown your documentation","slug":"markdown-your-documentation","link":"#markdown-your-documentation","children":[]},{"level":3,"title":"Host the Screenshots","slug":"host-the-screenshots","link":"#host-the-screenshots","children":[]},{"level":3,"title":"Screenshot Modification","slug":"screenshot-modification","link":"#screenshot-modification","children":[]}]},{"level":2,"title":"Deploy this Documentation","slug":"deploy-this-documentation","link":"#deploy-this-documentation","children":[]}],"git":{"createdTime":1752750935000,"updatedTime":1752750935000,"contributors":[{"name":"dependabot[bot]","email":"49699333+dependabot[bot]@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":1.27,"words":382},"filePathRelative":"documentation.md","localizedDate":"July 17, 2025","excerpt":"\\n<h2>Edit this Documentation</h2>\\n<p>Find the <a href=\\"https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/SUMMARY.md\\" target=\\"_blank\\" rel=\\"noopener noreferrer\\"><strong>table of contents</strong> for this documentation on GitHub</a> and navigate to the file you need to update.</p>\\n<p>Click on the <strong>edit pencil</strong> on the right side directly above the text to edit this file in our repository.</p>"}');export{d as comp,c as data};