BookStack Internal Linking Guide
This guide covers how to create internal links between pages, use permalinks, and reuse content across the Crowned Credit wiki. Mastering internal linking keeps our knowledge base connected and easy to navigate.
Why Internal Links Matter
Internal links connect related content across our wiki. When a CSR reads about the cancellation process, they should be one click away from the retention scripts. When a closer reads objection handling, they should be linked to the pricing presentation page. Good linking means less searching and faster answers.
Method 1: Insert Link (Most Common)
This is the easiest way to link to another page in the wiki:
- In the page editor, highlight the text you want to turn into a link
- Click the chain/link icon in the toolbar (or press Ctrl+K)
- In the URL field, click the small book icon button next to the input — this opens a search dialog
- Search for the page, chapter, or book you want to link to
- Select it and click Save
Method 2: Permalinks (Stable Links)
Regular page URLs include the page name (called a "slug"). If someone renames the page, the old URL might break. Permalinks use the page ID instead, so they never break.
How to Get a Permalink
- Go to the page you want to link to
- Select any text on the page — a small popup will appear
- The popup shows a permalink URL in an input field
- Click the copy button next to it
- The format is:
https://wiki.getcrownedcredit.com/link/{page-id}
#section at the end that scrolls to where you selected. Remove the # and everything after it if you just want to link to the top of the page.
Method 3: Include Tags (Reuse Content Across Pages)
Sometimes you want the same content to appear on multiple pages without copy-pasting. Include tags pull content from one page into another — and if the source is updated, all pages that include it update automatically.
Basic Syntax
| Syntax | What It Does |
|---|---|
| Includes ALL content from page with ID 5 |
| Includes only the specific section from page 10 |
How to Get the Include Tag
- Go to the source page (the page with the content you want to reuse)
- Select the content you want to include
- A popup appears — by default it shows a permalink
- Click the link icon on the left side of the popup to switch to include tag mode
- Copy the include tag (looks like
) - Paste it into the other page where you want that content to appear
- Included content updates automatically when the source page changes
- Users need permission to view the source page for includes to work
- Includes work up to 3 levels deep (include within an include within an include)
- Included content is NOT searchable on the page it appears on — only on the original source page
Method 4: Section Anchors (Link to a Specific Section)
Every heading on a page has an anchor ID. You can link directly to a specific section:
- On the target page, hover over a heading — you may see a # link icon
- Right-click it and copy the link
- Or use the permalink popup method (select text near the heading) — the
#portion points to that section
Best Practices for Our Wiki
| Do | Don't |
|---|---|
| Link related pages together (e.g., cancellation scripts → retention scripts) | Leave pages as dead ends with no links out |
| Use the search dialog (book icon) when inserting links | Manually type or guess URLs |
| Use descriptive link text ("See the Retention Scripts") | Use "click here" as link text |
| Use include tags for shared content (CROA disclaimer, escalation chain) | Copy-paste the same content into 10 different pages |
| Use permalinks for important cross-references | Rely on slug-based URLs that break on rename |
Quick Reference: URL Formats
| Type | Format | Example |
|---|---|---|
| Regular page URL | /books/{book-slug}/page/{page-slug} | /books/sales-training/page/full-consultation-call-script |
| Permalink | /link/{page-id} | /link/198 |
| Section link | /link/{page-id}#{section-id} | /link/198#bkmrk-closing-the-call |
| Include tag | {{@page-id}} or {{@page-id#section-id}} | or |