Plans supporting the use of hyperlinks
| Professional | Business | Enterprise |
|---|---|---|
In Document360, you can add hyperlinks to text, images, or files within your articles or category pages. Hyperlinks help users navigate seamlessly between related content, external resources, or specific sections within the same article, enhancing the overall reading experience.
Imagine you're writing a installation guide for software installation. You can add a hyperlink to the download page, so users can quickly access the required software without searching for it.
NOTE
Replicated articles cannot be added as internal links within other articles.
Adding hyperlinks to an article
To add a hyperlink in the Markdown editor, follow these steps:
Select the desired text and click the Insert link () icon at the top of the editor.
The Link panel will appear.
In the Link text field, enter the text to be hyperlinked.
Choose one of the following linking options:
Link to an existing article: Start typing the article name in the Search & link to existing article field. A list of matching articles will appear.
Link to a specific heading in the current article: Use the Link to the current article heading dropdown to select an H2, H3, or H4 heading. The appropriate URL slug will be generated automatically.
Link to an external URL: Enter the desired URL in the Link field.
(Optional) To open the hyperlink in a new tab, select the Open in a new tab checkbox.
Click Ok to add the hyperlink to your content.
In the Advanced WYSIWYG editor, you can insert link in three ways:
Quick insert menu: Click the Link () icon in the Quick insert menu. The Quick insert menu will appear only when the block is empty.
Slash command: Use the slash command
/Link.Ctrl + K: Select the desired text and press
Ctrl+K.
The Link panel will appear.
In the Link text field, enter the text to be hyperlinked.
Choose one of the following linking options:
Link to an existing article: Start typing the article name in the Search & link to existing article field. A list of matching articles will appear.
Link to a specific heading in the current article: Use the Link to the current article heading dropdown to select an H2, H3, or H4 heading. The appropriate URL slug will be generated automatically.
Link to an external URL: Enter the desired URL in the Link field.
(Optional) To open the hyperlink in a new tab, select the Open in a new tab checkbox.
Click Insert to add the hyperlink to your content.
Editing or unlinking a hyperlink
In the Advanced WYSIWYG editor, follow these steps to edit or remove a hyperlink:
Click the hyperlinked text. A floating menu will appear.
To manage the hyperlink:
Open the link: Click on the link to visit the URL.
Edit the link: Click on the Edit () icon to modify the hyperlink.
Unlink the text: Click on the Unlink () icon to remove the hyperlink.
Copy the link: Click on the Copy () icon to copy the hyperlink.
NOTE
In Markdown editor, you need to manually edit the hyperlink.
Copying heading links in articles
To improve navigation and content sharing, a Copy link () icon will appear next to H2, H3, and H4 headings in articles in the Knowledge base site. When you hover over a heading, the Copy link () icon becomes visible, allowing you to quickly copy and share a direct hyperlink to that specific section.
This makes it easier for readers to refer to relevant parts of an article without scrolling through the entire content.
Bookmark links inside articles/page categories
When dealing with long articles or category pages, Bookmark links allow you to link directly to specific headings (H2, H3, H4) within the same article.
For example: If an article contains multiple sections, such as "Installation," "Configuration," and "Troubleshooting," you can create bookmark links for each heading. This allows readers to jump directly to the relevant section without scrolling.
In the Advanced WYSIWYG editor, follow these steps to bookmark links inside articles or page categories:
Select the desired text and press
Ctrl+K.The Link panel will appear.
In the Link to the current article heading field, choose a heading from the dropdown list. This creates a URL slug linking directly to that section.
If needed, select Open in a new tab.
Click Insert.
NOTE
The H3 and H4 headings will only be available in the dropdown if enabled in settings. To enable them, navigate to Settings () > Knowledge base site > Article settings & SEO > Article settings > Article right and ensure H3 and H4 are selected.
If you're using the Advanced WYSIWYG editor, you can also press
Ctrl+Kto quickly add hyperlink to the text.
Adding an Email link to an article
To add an email link to an article in Markdown editor, follow the steps below:
Select the text you want to link and click the Link () icon.
In the Link field, use the following Markdown format to create an email link:
[link_text](mailto:email_id)
For example, if you want to add an email hyperlink to
test@gmail.comwith the link text "Email support", type:
[Email support](mailto:test@gmail.com).Outcome: Email support
To add an email link to an article in the Advanced WYSIWYG editor, follow the steps below:
Select the desired text and press
Ctrl + Kor use the slash command/link.The Link panel will appear.
In the Link field, type the desired email in this format:
(mailto:email_id).Click Insert.
Effect of changing an article heading on Hyperlinks
If you change the heading, the existing hyperlink will break.
For example: If you add a hyperlink to an H3 heading titled "Markdown editor" and later change the heading to "The Markdown editor," the hyperlink will break and no longer work.
How to overcome this scenario?
This method is applicable only in the WYSIWYG editor. When you directly update a heading, both the heading link and name are updated. However, to change the heading without affecting the heading link, you need to update the HTML tag for the heading ID.
Typically, an H2 heading is formatted as <h2>Heading name</h2>. To separate the heading link from the name, you can modify the tag as <h2><a name="heading-link"></a>Heading name</h2>.
For example, you want to update the H2 heading name 'How Risk Analytics Works' to 'Risk Analytics'
Your current heading tag would be
<h2>How Risk Analytics Works</h2>Replace it with
<h2><a name="How-Risk-Analytics-Works"></a>How Risk Analytics Works</h2>
Heading link -How-Risk-Analytics-Works
Heading name -How Risk Analytics WorksNow change the heading name to Risking analytics, and don't change the heading link
<h2><a name="How-Risk-Analytics-Works"></a>Risk Analytics</h2>If you have added a hyperlink for this heading, it will work fine even after changing the heading name. This is because the heading link is kept the same.
Effect of Machine translation on Hyperlinks
When an article is translated, all internal hyperlinks in the original language are updated to link to the corresponding translated articles in the new/draft state.
For example: An article in English contains internal links to other articles. When translated to French, those links will redirect to the French versions of the linked articles.
NOTE
To avoid broken links in translated articles, ensure that article slugs are consistent across languages.
For example, if the English article has the slug
/getting-started, use the same slug for the translated version (e.g.,/getting-startedfor German). This will help maintain link consistency. This is because when you add a redirect rule, the hyperlink URL text for English language isdocs/en/article_slugand for German language isdocs/de/article_slug.
Types of URLs
Absolute path/URL
An Absolute path/URL includes the entire web address, from the protocol (HTTP/HTTPS) to the domain name and the path within the site. It is the complete address required to access a specific webpage, regardless of the site you are currently on. An absolute URL is used when linking to external websites or when you want to specify the full address of a page.
For example: https://docs.document360.com/docs/v3/overview/interface
Relative path/URL
A Relative path/URL is a shortened version of the URL that only specifies the location after the domain. It assumes that the link is within the same site and shares the same root domain. The relative path always starts with a forward slash (/). It is commonly used for internal links within the same site.
In Document360, relative paths are used in several places, such as the linking feature in the editor, article redirect rules, tag redirect rules, and the ticket deflector.
For example: https://docs.document360.com/docs/v3/overview/interface
Relative path: /v3/overview/interface
FAQs
How do I link to an existing article in my Knowledge base?
Highlight the text you want to link, click on the Link () icon in the editor toolbar, type the article name in the search field, select the article, and click Insert.
Can I link to headings within the same article?
Yes, you can link to headings (H2, H3, H4) within the same article using the hyperlink () tool in the editor.
Do hyperlinks get auto-updated when I translate an article?
Yes, when you translate an article, all hyperlinks in the default language will direct to the respective translated language in the new article.
How can I link a new article to another article before it gets published?
You can link new unpublished articles to other articles before publishing them by following these steps:
Hover over the desired text in the editor and click the Insert link () icon.
In the Search & link to existing article dropdown, enter the name of the new article and select it.
If needed, check the Open in a new tab option to have the link open in a new tab.
Once finished, click Insert.
NOTE
Until you publish the linked new article, the link will be in a broken state.
Does an article heading hyperlink still work when I change the heading name?
No, hyperlinks would not work when you change the heading name. For example, if you have added a hyperlink for the H3 heading as “Markdown editor”, and later you change the H3 heading to "The Markdown editor", then the hyperlink would not work.
Visit this link to find a workaround.