Zum Inhalt
BeeWare Werkzeuge für die Dokumentation
2025.12.3.29402.dev1

Prüfstand für gemeinsam genutzte Inhalte

Dieser Abschnitt dient dazu, die von diesem Repository bereitgestellten gemeinsamen Inhalte für die Verwendung in der übrigen BeeWare-Dokumentation zu überprüfen. "Gemeinsame Inhalte" beziehen sich auf Dokumente oder Abschnitte von Dokumenten, die in mehreren anderen Repos vorhanden sind. Sie werden hier gespeichert, um in diese Repos aufgenommen zu werden. Das bedeutet, dass es eine einzige Quelle gibt, wenn Aktualisierungen erforderlich sind, und dass diese Änderungen in alle Repos übernommen werden, die diese gemeinsamen Inhalte verwenden.

Wenn Sie bestehende Inhalte aktualisieren, sind die folgenden Schritte nicht erforderlich. Sie können einfach die Test-Site erstellen und sehen, wie Ihre Aktualisierungen gerendert werden.

If you are creating a new shared documentation file in the shared-content directory, that is NOT meant to be included in the how-to directory, complete the following:

  1. Erstellen Sie eine Datei im content_test_bed, die den gleichen Namen wie Ihre neue Inhaltsdatei hat, mit einem angehängten "_include" am Ende.
  2. Für style_guide.md würden Sie style_guide_include.md hinzufügen.
  3. Verwenden Sie die Snippets-Syntax und fügen Sie den Dateinamen in die Datei "filename_include.md" ein. Die Snippets-Syntax für das Einfügen von Inhalten ist -8<- "Dateiname.md".
  4. Für style_guide.md würden Sie -8<- "style_guide.md" zu style_guide_include.md hinzufügen.
  5. Aktualisieren Sie den Abschnitt Shared content test bed in /docs/SUMMARY.md, um die neue _include Datei und den Pfad auf der gleichen Einrückungsebene wie die anderen Elemente in diesem Abschnitt aufzunehmen.
  6. Für style_guide_include.md würden Sie - [Style guide](content_test_bed/style_guide_include.md) hinzufügen.

Sobald diese Schritte abgeschlossen sind, können Sie die Test-Site erstellen und Ihre neue Dokumentation gerendert betrachten.