AX Links

This extension provides the following features:

• Link autocompletion:
  • for internal links (including headers)
  • for images
• Shortcode for including sections
• Automated Weight Adjustment

Note: This extension was developed to be used with hugo and our PDF tool.

Link autocompletion

To start the link autocompletion, insert [] brackets. A box will appear, that lets you search for the link you want to insert.

The icon on the left side, tells you the category of completion:

• File
• Header
• Image

You can search for headers by typing # and the name of your header.

Image Options

You have to insert a ! before the [] brackets, if you want to include an image.

To include images (for hugodocs), insert {} brackets. The ax_image shortcode has the following options:

• inline: makes the image inline.
• size: resizes the image.

The extension will ask you to:

• select the source.
• select if the image should be inline or not.
• what size the image should have.

The output looks like this:

{{% ax_image src="<path_to_image>.png" inline="true" size="small" %}}

Note: Inline can only be set to true. If you select the empty option, the output will look like this:

{{% ax_image src="<path_to_image>.png" size="small" %}}

Note: The size option only supports the following values: small, medium, large. If you select the empty option, the output will look like this:

{{% ax_image src="<path_to_image>.png" inline="true" %}}

Restrictions

If you select the empty option for inline and size, the build will fail.

Include Sections

To use the include sections shortcode, create a sections folder in the content folder.

The sections folder must include a _index.md file. This file must contain the following:

---
draft: true
---

Now you can create files in the sections folder, that contain sections you use multiple times in your document.

To include a section, insert {} brackets and choose the section you want to include.

Input:

{{% include "<path_to_section>" %}}

Output:

this is a test for the include shortcode.

Restrictions

It is not advised to include the following in the sections:

• Links
• Inline Images

Automated Weight Adjustment

When adjusting the weight of a markdown file to an existing weight/ adding a new file with an existing weight, all weights starting from the modified weight will automatically be adjusted on save. For example:

• NewFile: Weight 3
• File1: Original Weight 3, Adjusted Weight 4
• File2: Original Weight 4, Adjusted Weight 5

You can view the changes in the output tab.