Docs
circleci.com
Start Building for Free

Cross references and links

4 days ago1 min read

Cross references

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

    xref: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.

  • 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)

Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.