Dokumentation

Links in der Dokumentation verwenden

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Dieser Artikel beschreibt die Verwendung von Hyperlinks in Dokumentationsseiten. Links können mit einigen unterschiedlichen Konventionen einfach in Markdown eingefügt werden. Links verweisen auf Inhalte auf derselben Seite, auf andere benachbarte Seiten oder auf externe Sites und URLs.

IMPORTANT
Alle Links sollten idealerweise sicher sein (https vs. http), wenn das Ziel dies unterstützt (was überwiegend der Fall sein sollte).

Die Wörter, die Sie in den Linktext einschließen, sollten dem Titel der Seite entsprechen, auf die Sie verlinken, oder spezifischem, beschreibendem Text.

Beispiele:

  • For more information, see the [overview article](https://github.com/AdobeDocs/target.en/help/overview.md).

  • For more details, see [Adobe Legal Concerns](https://www.adobe.com/legal).

Verwenden Sie die folgende Linksyntax, um einen Inline-Link von einem Artikel zu einem anderen innerhalb desselben Repositorys zu erstellen:

  • Ein Artikel in einem Ordner verlinkt auf einen anderen Artikel im selben Verzeichnis:

    [link text](article-name.md)

  • Ein Artikel verlinkt aus einem Unterverzeichnis auf einen Artikel im Stammverzeichnis:

    [link text](../article-name.md)

  • Ein Artikel verlinkt aus einem untergeordneten Unterverzeichnis auf einen Artikel im Stammverzeichnis:

    [link text](../../article-name.md)

  • Ein Artikel im Stammordner verlinkt auf einen Artikel in einem Unterverzeichnis:

    [link text](./directory/article-name.md)

  • Ein Artikel in einem Unterverzeichnis verlinkt auf einen Artikel in einem anderen Unterverzeichnis:

    [link text](../directory/article-name.md)

  • Ein Artikel in einem untergeordneten Unterverzeichnis verlinkt auf einen Artikel in einem anderen Unterverzeichnis:

    [link text](../../directory/article-name.md)

Sie müssen keine Anker erstellen. Sie werden automatisch zum Veröffentlichungszeitpunkt aller H2-Überschriften generiert. Sie müssen nur Links zu den H2-Abschnitten (##) erstellen.

  • So verlinken Sie auf eine Überschrift im selben Artikel:

    [link](#the-text-of-the-level2-section-separated-by-hyphens)

    [Link to anchors](#links-to-anchors)

  • So verlinken Sie einen Anker in einem anderen Artikel im selben Unterverzeichnis:

    [link text](article-name.md#anchor-name)

    [Configure your profile](overview.md#getting-started)

  • So verlinken Sie einen Anker in einem anderen Dienstunterverzeichnis:

    [link text](../directory/article-name.md#anchor-name)

    [Configure your profile](../overview.md#configure-your-profile)

Es empfiehlt sich, Bilder und Dateien in einem assets-Verzeichnis auf derselben Ebene wie die Markdown-Datei zu speichern, die darauf verlinkt.

  • Ein Artikel verlinkt zu einem Bild im assets-Unterverzeichnis:

    ![alt text](assets/image-name.png)

  • Ein Artikel verlinkt zu einem Bild im assets/no-localize-Unterverzeichnis:

    ![alt text](assets/no-localize/image-name.png)

recommendation-more-help
f0a0e44c-5d56-45af-ac98-47677caca18f