Ссылки

Ссылки в документации обрабатываются по особым соглашениям.

Если ссылка не ведет на файл из проекта, она оставляется без изменений.

  • [Ant](http://ant.apache.org/) - ссылка на http://ant.apache.org/ с текстом Ant
  • [](http://ant.apache.org/) - ссылка на http://ant.apache.org/ с текстом http://ant.apache.org/

Если ссылка начинается с /, то она рассматривается как путь с корня документации. Если ссылка не начинается с /, то сначала она рассматривается как путь относительно файла, где ссылка встретилась. Если не найдена - то рассматривается как путь с корня документации.

  • [](topic1.md) - ссылка на topic1.md в этом же каталоге
  • [](./topic1.md) - ссылка на topic1.md в этом же каталоге
  • [](../topic1.md) - ссылка на topic1.md в каталоге выше уровнем
  • [](/section1/topic1.md) - абсолютная ссылка на section/topic1.md

Если ссылка выглядит как путь без расширения, то считается, что она указывает на файл со статьей.

  • [](topic1.md) - ссылка на topic1.md в этом же каталоге
  • [](topic1) - ссылка на topic1.md в этом же каталоге

Если текст ссылки не указан, и ссылка на файл статьи, то в качестве текста принимается заголовок статьи.

  • [смотрите тут](/intro/install) - ссылка с текстом смотрите тут на файл intro/instal.md
  • [](/intro/install) - ссылка с текстом заголовка статьи из файла intro/instal.md

Если текст ссылки не указан, и ссылка на файл,который не является статьей, то в качестве текста принимается полный путь файла.

  • [картинка](/images/img1.png) - ссылка с текстом картинка на файл /images/img1.png
  • [](/images/img1.png) - ссылка с текстом images/img1.png на файл /images/img1.png