Linking
guideReferencing syntaxes, entities, events and other doc pages.
The reference format
References mirror the site's URLs: open any syntax on its atlas page, click its link button, and paste the path without the origin:
You want | You write | Lands on |
|---|---|---|
A syntax on an entity |
|
|
A Core / Global syntax |
|
|
An event |
|
|
An entity page |
|
|
Another doc page |
|
|
Syntax cards
A standalone syntax: line renders a live card of the syntax: kind, pattern, description and meta, all clickable:
[the] members of %guild%The members of the guild. Without 'await' this is the cached member list, which may be incomplete depending on the bot's cache settings.Readers pick how much detail these cards show in Settings → Documentation; you can force a level per card when it matters, with a trailing compact, standard or full:
[the] nickname of %member%A guild member's nickname, which is their display name on that guild. Co-owned with Skript's native Property.DISPLAY_NAME, so "nickname of", "display name of" and "custom name of" all reach it.effect
AwaitCore · Effectsawait <.+>Runs an effect on a background thread and waits for it to fully complete before continuing.Events and entities get cards the same way:
event Message ReceiveEventsmessage receive[d]Fired when a bot receives a message — in a guild or in private messages by default. Use 'event is from guild' to filter.
Member
type
34 syntaxes
A user within a guild: roles, nickname, flags, activities and dates.Doc-to-doc cards
Writing pages guide How to contributeFile layout, frontmatter and everything a doc page is made of.Inline links
Reference anything mid-sentence with a scheme link: the members property of a guild, the message receive event, the Member entity, or the setup guide.
Hovering an inline syntax: / entity: / event: link previews the element's reference card without leaving the page; try it on the links above.
Relative links between pages just work with plain file paths: Components or with a heading fragment, the admonition list.
What links back
Every reference you make is indexed both ways:
- The syntax's record shows a mentioned in chip pointing to your page (deep-linked to the nearest heading above the mention).
- Pages listed in your frontmatter
syntaxes:get the stronger "Feeling lost?" guide banner on their records instead. - Entity pages list every page that touches them in a Documentation section.
When a reference breaks
Typos never crash a page; they degrade into a visible warning card and are listed at startup (and on /docs in development mode). This one is intentionally broken:
A deliberately broken reference (click to see the degraded card)
syntax:guild#this-does-not-exist; check the id
(copy it from the syntax's link button on its atlas page).