EDITOR
Editor Blocks

Link Blocks

17min
Document image


Link Block is an element that combines the visual appeal of a card with the functionality of a clickable item. It's perfect for highlighting important information or showcasing related resources.

When to use it

  • Highlight key information
    Create attention-grabbing cards for important announcements or updates.
  • Showcase related content
    Link to additional resources, articles, or products.
  • Create a visually appealing directory
    Organize information into clickable cards for easy navigation.
  • Enhance user experience
    Provide a clear and interactive way to guide users through your content.

How to create a Link Block

1

Type / to open Archbee block menu

2

Search for Link Blocks and click to insert

Document image

3

Customize the card header in your own way! You have two options:

  • Solid Color
  • Image
  • Or you can to leave it empty, and in that case, we will only display the content from inside.
4

Feel free to add your content. You can style the content however you like using the WYSIWYG Menu or even insert other blocks, like:

🚨 Limitations

You can't reareange them, so be carefull when you are creating Link Blocks (we have it on our roadmap).

Solid color header

You can use a color as the header to make your card more visible. You can even use code colors to match your features.

1

Click on the  Color button

Document image

2

Click on the Change header area

3

Select your preferred color. Any changes made will be saved automatically

Document image


To manage the card header, use the following buttons:

  •  — go to main menu to change the header
  •  — remove the card

Image header

You can use an image as the header to describe the content inside the card and make it more aesthetically pleasing.

1

Click on  Image button

Document image

2

Click on the + Add Image area

3

Choose your desired image. Any changes made will be saved automatically

Document image


To manage the card, use the following buttons:

  •  — go to main menu to change the header
  •  — remove the card
  •  — choose/reupload another image
  •  — delete the image

Guide

Image Guide for Link Block
Image Guide for Link Block


To ensure that your content is displayed properly, we recommend to create an image with a height of 480px and a width of 1324px. By following the visible area guide below, you can ensure that your content is not cut off.

Visible Area

The main image has dimensions of 480px in height and 1324px in width.

  • In the case of having 3 link blocks per row, the visible area will be 480px in height and 860px in width. This visible area will be centered within the main dimensions. Please refer to the image below for a visual representation:
Document image




  • When there are 2 link blocks per row, the visible area will be determined by the main dimensions. To provide a better understanding, please refer to the image below:
2 link blocks per row




  • When there is only 1 link block per row, the visible area will be centered within the main dimensions. Specifically, it will have a width of 1324px and a height of 234px. To get a better understanding, please refer to the image below:
Link block per row


To clarify, the primary content or logo should be positioned in this designated area.

Document image


Please find below a live demonstration of the cover image and its behavior.

PRO TIP 😎

To make link block in the Archbee way, leave the header emplty and insert an image block inside of a link block. You will love it! 😉 ( 🚨 The downside is that clicking on an image will display a glitch for a second as the image viewer loads)

Markdown

Here's how to create a tab in your document using markdown code:

1

Create the link block Start with the ::::link-array line.

2

Add a link card Each link block content goes between :::link-array-item and ::: markers.

3

Choose the headerType You have two options for your header:

  • IMAGE: This displays an image as your header background.
  • COLOR: This allows you to use a solid color for your header.
4

Add the appropriate attribute

For IMAGE headers:

  • Add the image URL as the value for the headerImage attribute.
  • Example: headerImage="https://placehold.co/600x400")

For COLOR headers:

  • Define the desired color using a hex code for the headerColor attribute.
  • Example: headerColor="#ff00FF"
5

Add content inside of your link card.

🚨 Attention!

When using the triple colon (:::) syntax to create a nested markdown element, ensure that each parent element above it also has an extra colon (:) before its opening triple colon.

Markdown


Here is the result:

Check the Use Markdown shortcuts page to see more markdown shortcuts for other blocks.

Examples

Examples? For a link block? Dude, it's like finding water in the ocean. You can't avoid it. Our docs are swimming with 'em! On this page there are 8 of them, plus images.

Custom CSS

Throughout our extensive experience, we have been dedicated to helping customers personalize their documentation according to their unique preferences. Additionally, we have offered valuable assistance that we believe will also be of great benefit to you in crafting exceptional documentation for your product.

Set link to be sticky at bottom

Set your links inside of the Link Block to be sticky at the bottom of the card.

CSS





🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.



Updated 16 Oct 2024
Doc contributor
Did this page help you?