feat(docs): improve external links documentation

This commit is contained in:
Elian Doran
2025-04-12 11:41:37 +03:00
parent 60217d4e4f
commit bede12f3f6
12 changed files with 85 additions and 18 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 363 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 695 B

@@ -1,13 +1,40 @@
<h2>External links</h2>
<p>External link is general web link targeting some external web resource
- e.g. <a href="https://en.wikipedia.org/wiki/South_China_Sea">https://en.wikipedia.org/wiki/South_China_Sea</a> is
an external link to one Wikipedia page.</p>
<p>External links are done through CKEditor native links. To create an external
link, select text and press <kbd>Ctrl</kbd> + <kbd>K</kbd> or wait for the
"balloon" to appear and click link icon there.</p>
<p>
<img src="Links_create-external-link.gif">
</p>
<p>An external link is a standard web link targeting for example a website.
For example, <a href="https://en.wikipedia.org/wiki/South_China_Sea">https://en.wikipedia.org/wiki/South_China_Sea</a> is
an external link to a Wikipedia page.</p>
<p>To create a link without a custom text:</p>
<ul>
<li>Press
<img src="1_Links_image.png" width="15" height="16">in the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/_help_nRhnJkTT8cPs">Formatting toolbar</a>:
<ul>
<li>A popup will appear, type or paste the URL in the box.</li>
<li>Press <kbd>Enter</kbd> or the check mark icon to confirm.</li>
</ul>
</li>
<li>Alternatively, press <kbd>Ctrl</kbd>+<kbd>K</kbd> to trigger the aforementioned
popup.</li>
<li>A simpler way is to paste the raw link and press space to turn it automatically
into a link.</li>
</ul>
<p>To create a link with a custom text:</p>
<ul>
<li>First, type and select the text which will be turned into a link.</li>
<li>Follow the previous steps to open the link interface (via the formatting
toolbar, or <kbd>Ctrl</kbd>+<kbd>K</kbd>).</li>
<li>Alternatively, simply paste (<kbd>Ctrl</kbd>+<kbd>V</kbd>) over the selected
text to turn it into a link.</li>
</ul>
<p>Once a link is inserted:</p>
<ul>
<li>The text inside the link can be changed if needed but the link itself
will remain.</li>
<li>To modify the link, click on the link to display the popup and press the
<img
src="Links_image.png" width="18" height="18"> <em>Edit link</em> button.</li>
<li>To remove a link, click on it and press the
<img src="2_Links_image.png"
width="18" height="18"> <em>Unlink</em> button.</li>
</ul>
<p>You can follow external link by either double clicking (will open new
tab/window) it or right clicking on them and choosing "Open in new tab".</p>
<h2>Internal links to notes</h2>
Binary file not shown.

Before

Width:  |  Height:  |  Size: 356 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 594 B