CONTRIBUTING.md wird nicht als Webseite auf GitHub-Seiten gerendert

Question

Ich bin dabei, meine contributing.md-Datei aus dem Projektstamm in das docs/-Verzeichnis zu verschieben, so dass es mit dem Rest der Dokumentation sein kann. Andere Markdown-Dateien in Dokumenten werden ordnungsgemäß gerendert, wenn sie in GitHub-Seiten angezeigt werden. Die Seite

https://jtablesaw.github.io/tablesaw/userguide/toc rendert die Seite toc.md wie erwartet.

jedoch

https://jtablesaw.github.io/tablesaw/contributing

kehrt a 404, während einfach die Verlängerung .md Zugabe

https://jtablesaw.github.io/tablesaw/contributing.md

gibt die Seite als Abschlags Quelle

Das github Projekt https://github.com/jtablesaw/tablesaw . und die contributing.md-Datei befindet sich im Ordner docs /.

Answer 1

Zachary's Antwort ist korrekt, aber es gibt eine Möglichkeit, die jekyll-Konfiguration so zu modifizieren, dass sie die spezifische Seite enthält. Hier

ein Beispiel: https://masterex.github.io/test-docs/contributing

Sie haben _config.yml wie folgt zu ändern:

theme: jekyll-theme-minimal 
include: contributing.md 

Here ist Github relevante Hilfeseite.

Answer 2

Nach your repo gabeln, spielen, um mit ihm ein wenig, und schlug meinen Kopf gegen die Wand, weil ich nicht verstehen, warum es nicht funktionierte, erkannte ich etwas:

Github Seiten nicht unterstützt den Aufbau von Jekyll-Seiten aus Dateien mit Namen, die Github für andere Zwecke erkennt. Diese Dateinamen enthalten (zusätzlich zu ihren Kleinen Versionen):

• CONTRIBUTING.md
• ISSUE_TEMPLATE.md
• PULL_REQUEST_TEMPLATE.md
• ISSUE_AND_PULL_REQUEST_TEMPLATE.md
• CODEOWNERS.md

Auf der anderen Seite, trotz dass README.md ist al Also eine Github-Schlüsselwortdatei, es sieht so aus, als ob Github Pages die Verwendung von Dateien mit dem Namen README.md unterstützt, weil es sie absichtlich genauso interpretiert wie eine index.md oder index.html Datei. Weitere Informationen finden Sie unter this link from the Github blog.

---

Um Ihre Frage zu beantworten, wie Sie die Datei auf dem /tablesaw/contributing Weg zu zeigen, bekommen konnten, können Sie es umbenennen und auf den Pfad /docs/contributing/index.md oder /docs/contributing/README.md bewegen.

Leider ̶ MINDESTENS in der Gegenwart, ̶ wurde leider zur Zeit keine Möglichkeit, sicher zu stellen, mit dem gleichen Dateinamen und haben GitHub SEITEN BUILD eine Seite für sie.̶

---

Edit:@Master_ex Noten richtig, dass Sie die include configuration option in der _config.yml Datei verwenden können, um Dateien, die normalerweise von Github ausgeschlossen würden:

theme: jekyll-theme-minimal 
include: contributing.md 

In Bezug auf das ursprüngliche Beispiel, Auf diese Weise kann Github Pages erfolgreich eine Seite unter dem Pfad /docs/contributing erstellen.