Add note on absolute links

[jingting1412]

What is the purpose of this pull request?

• [x] Documentation update
• [ ] Bug fix
• [ ] Feature addition or enhancement
• [ ] Code maintenance
• [ ] DevOps
• [ ] Improve developer experience
• [ ] Others, please explain:

Overview of changes:

9 and #278

When including contents with links, {{baseUrl}} is required to be added to the link if the user wants it to point to the absolute location. Without this note, some users might not realise this can result in broken links as shown in issue #278

Anything you'd like to highlight/discuss:

Testing instructions: markbind serve -d the docs the see if the warning message under the includes section is clear.

Proposed commit message: (wrap lines at 72 characters) Add note on URLs in includes

---

Checklist: :ballot_box_with_check:

• [ ] Updated the documentation for feature additions and enhancements
• [ ] Added tests for bug fixes or features
• [x] Linked all related issues
• [x] No unrelated changes

---

Reviewer checklist:

Indicate the SEMVER impact of the PR:

• [ ] Major (when you make incompatible API changes)
• [ ] Minor (when you add functionality in a backward compatible manner)
• [ ] Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

• To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

• what was the old feature that was made obsolete
• any replacement feature (if any), and
• how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

[jingting1412]

Hi @jingting1412 thanks for the work!

I think this issue about using baseUrl isn't just applicable to includes. It also affects panels, modals etc which use links.

Could you update those areas also? Gentle reminder to use includes to avoid duplication.

Would be also good to add it to troubleshooting section in our user guide

Yep for sure! I've added the tip in more places where I think its relevant and the troubleshooting section. Do let me know if I need to refine my explanation or add the tip to more places.

[kaixin-hc]

@jingting1412 hi, refer to this image for what i mean about weird spacing... could you add a new line where it makes sense to avoid this kind of 0 margin case?

And this warning is redundant.

Thanks!

[jingting1412]

@jingting1412 hi, refer to this image for what i mean about weird spacing... could you add a new line where it makes sense to avoid this kind of 0 margin case?

And this warning is redundant.

Thanks!

Hi thanks for the spot! I've fixed those areas now

[github-actions[bot]]

@Tim-Siu Each PR must have a SEMVER impact label, please remember to label the PR properly.