Start Building for Free

Cross references and links

1+ year ago1 min read

Cross references

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

    link:/docs/github-integration#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:

  • The markdown link syntax is as follows:


Suggest an edit to this page

Make a contribution
Learn how to contribute