Cross references and links

1 month ago · 1 min read

This page covers how to create links and cross references in CircleCI docs.

Cross references

Make cross references (links between docs pages) by using the resource ID of the destination page and section, in the following form:
```
xref:guides:integration:github-integration.adoc#user-keys-and-deploy-keys[User Keys and Deploy Keys]
```
See the Resource ID coordinates page in the Antora docs for more information.
Cross references should explicitly name the document or section to which they are linking.
- Good: Refer to the Setting an environment variable in a project section of the Environment Variables document.
- Bad: For more information on adding project-level environment variables head here.