Quick Start Guide for Cross-Linking Extension

This is the quick start guide for the Cross-Linking extension. We'll get you up and running in about 5 minutes. This covers the basics — enabling the module, creating your first cross-link rule, and verifying it works on your store. If you want to quickly start building internal links without manually editing content, you're in the right place.

4 steps to get it working.

Prerequisites

• Module installed via composer
• Cache cleared
• At least one product, category or CMS page with text content

Step 1: Enable the Extension

Navigate to: Stores → Configuration → Magmodules → Cross-Linking → General

Configure:

• Enabled: Yes
• Case Insensitive: Yes (recommended for most stores)

Step 2: Enable Entity Types

In the same configuration section, configure which content types should have cross-links:

Products section:

• Enable for Products: Yes
• Max Links Per Page: 10

Categories section:

• Enable for Categories: Yes
• Max Links Per Page: 10

CMS Pages section:

• Enable for CMS Pages: Yes
• Max Links Per Page: 10

Step 3: Create Your First Cross-Link Rule

Navigate to: Marketing → Cross-Links

Click Add New Cross-Link and configure:

• Keyword: The word or phrase to match (e.g., "yoga mats")
• URL: The link target (e.g., /collections/yoga-mats.html)
• Max Replacements: 1 (replace only the first occurrence per page)
• Active: Yes
• Store Views: All Store Views

Save the rule.

Step 4: Test Your Configuration

1. Clear the cache: System → Cache Management → Flush Magento Cache
2. Visit a product page, category page or CMS page that contains your keyword
3. Verify the keyword is now a clickable link pointing to the URL you configured
4. View page source and search for your URL to confirm the anchor tag is present

Tip: You can also use the CLI preview command to verify replacements without visiting the frontend:

bin/magento magmodules:crosslinking:preview --entity-type=product --entity-id=42

This shows the before/after output so you can confirm links are being inserted correctly.

Verification Checklist

• Module is enabled in General settings
• At least one entity type (Products/Categories/CMS) is enabled
• Cross-link rule is active and has correct keyword + URL
• The keyword actually exists in the page content (not inside an existing link)
• Cache has been flushed after making changes

Need More Help?

Documentation:

• All Help Articles - Complete documentation overview

Support:

• Contact Support - Get help from our team