Go to Application

Cross references and links

2 months ago · 1 min read

Cross references

Cross references (links between docs pages) in .adoc should be made in the following form:

xref:guides:integration:github-integration.adoc#user-keys-and-deploy-keys[User Keys and Deploy Keys]

The .md equivalent would be to use a link:

[User Keys and Deploy Keys](/github-integration#user-keys-and-deploy-keys)

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: See here for info on adding project-level environment variables.

Links

Links to third party sites should be in the following form in asciidoc content:
```
link:https://circleci.com[CircleCI]
```
The markdown link syntax is as follows:
```
[CircleCI](https://circleci.com)
```