Ich habe gerade diese elasticsearch link gelesen. Ich habe die Bearbeitungsoption für jede Überschrift gefunden, die mich auf die GitHub-Website umgeleitet hat. Ich weiß, Git bietet Wiki-Option mit jedem Konto, aber das ist nur auf GitHub gehostet und unterstützt begrenzte Funktionen.Wie erstellt man Dokumentation, die mit GitHub verknüpft ist?
Wie kann ich Dokumentation wie diese machen, die mit GitHub verknüpft ist?
Es sieht so aus, als ob sie AsciiDoc verwenden und das Repository einfach auf Github setzen.
Die Bearbeitungsverknüpfungen scheinen keine besondere Eigenschaft von AsciiDoc zu sein. Sie sind einfache URLs des Formulars https://github.com/<owner>/<repo>/edit/5.x/<path>. Vermutlich regeneriert jemand die Seite, nachdem sie eine Pull-Anfrage akzeptiert hat.
Dies funktioniert mit den meisten Website-Generierungstools, scheint jedoch nichts mit AsciiDoc zu tun zu haben.
Ich las:
https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/nest-getting-started.html
Dann möchte ich bearbeiten, es Umleitung zu:
https://github.com/elastic/elasticsearch-net/edit/5.x/docs/client-concepts/high-level/getting-started.asciidoc
Link-Quellcode:
https://github.com/elastic/elasticsearch-net/blob/5.x/docs/client-concepts/high-level/getting-started.asciidoc
URL file:
elasticsearch-net/docs/client-concepts/high-level/getting-started.asciidoc
Der Unterschied ist URL-Parameter: edit und blob. Wie erstellt man Dokumentation, die mit GitHub verknüpft ist? So einfach, verwenden Sie diese Konvention, wenn Sie eine statische Dokumentdatei erstellen.