Abschriften zu HTML von GitHub README.md Datei

Question

Mein Ziel ist,

1) Lesen Sie die Markdown Quelle aus README.md Datei von meinem GitHub Repo.
2) Konvertieren Sie den Markdown in HTML-Code.
3) Wenden Sie das Ausgabe-HTML auf eine <div> an.

nur mit clientseitigen Technologien.

Ich weiß, wie Sie Markdown-Code mit jQuery in HTML konvertieren, aber nicht wissen, wie Sie die MD-Quelle aus README.md-Datei von GitHub Repo dynamisch lesen.

Answer 1

1. die RAW-Datei URL der README.md Datei holen aus dem GitHub Repo.
2. Formatieren Sie die URL im folgenden Format: http://markdown.io/<url_readme_file>. Angenommen, die URL meiner Datei "readme.md" lautet http://raw.github.com/pankajparashar/nerdy-css/master/README.md. Daher wird die neue URL http://markdown.io/http://raw.github.com/pankajparashar/nerdy-css/master/README.md
3. Jetzt verwenden Sie die Lade-Methode jQuery mit dieser neuen URL und extrahieren Sie den Inhalt von #md-content ID der Seite.

komplette Demo der obigen Schritte finden Sie hier - http://jsfiddle.net/pankajparashar/EQBFZ/

Answer 2

1. Gehen Sie zu Ihrem GitHub Projektseite
2. Klicken Sie auf Ihre README.md Datei
3. Klicken Sie nun auf die Raw Taste

Die RAW-Datei ist die tatsächliche URL Sie laden möchten, werden zu .

Erstellen Sie eine PHP (oder was auch immer serverseitige Sprache Sie verwenden) Datei mit dem Namen load.php speziell zum Laden von Remote-Dateien (wie Ihre RAW-Datei). Das PHP-Skript akzeptiert eine $_GET['url'] Variable. Übergeben Sie die Variable an file_get_contents(), und geben Sie die Ergebnisse aus. Bitte beachten Sie, dass der folgende Code ein sehr einfaches Beispiel ist. Jetzt

echo file_get_contents($_GET['url']); 

, benutzen Sie einfach die load Funktion in jQuery in den Dateninhalten aus der PHP-Datei zu bringen. Ihre URL wird wahrscheinlich ähnlich formatiert sein wie diese ...

Schließlich, verwenden Sie, was auch immer Sie bereits beschrieben, um Markdown zu konvertieren.

• PHP file_get_contents(): http://php.net/manual/en/function.file-get-contents.php
• jQuery load(): http://api.jquery.com/load/
• Mehr Infos über die Same-Origin-Policy unter Umgehung: http://www.mikazo.com/2010/09/how-to-getting-around-ajax-same-origin.html

Answer 3

sollten Check-out:

https://github.com/zmckinnon/jquery-gh-readme

Es nutzt die GitHub API den Inhalt der Readme-Datei mit diesem Aufruf abzurufen:

Erhalte/repos /: besitzer /: repo/readme

Dann konvertiert es den base64-verschlüsselten Inhalt.

Dann konvertiert es den Markdown-Inhalt in HTML mit markierten.

Answer 4

Es ist bemerkenswert zu verstehen, dass HTML in der ReadMe.md-Datei funktioniert. Mit diesem klaren Verständnis würde ich viele dieser Fragen automatisch beantworten, wie - wie man eine Fettschrift in der ReadMe-Datei erstellt oder wie man ein Bild einfügt usw. Beachten Sie auch, dass es sehr davon abhängt, welchen Anwendung/Text-Editor Sie verwenden auch viel über das Betriebssystem. Kürzlich hatte ich Probleme beim Einfügen von Leerzeichen in die Datei Readme.md von Github.

I bevorzugt persönlich < br /> Tag dort, und ich habe einen vollständigen Beitrag das gleiche beschreiben: http://www.w3lc.com/2017/05/new-line-in-readme-file-github-fixing.html

ich die Änderung in einem git commit im Github-Repository in der Post erklärte unter Beweis gestellt habe. Dieses Verständnis ist sehr notwendig, um die Frage zu behandeln und auch viele andere Anwendungen zu finden, warum Sie es wahrscheinlich tun müssten!

Weiter, um Ihre Frage direkt zu beantworten, benötigen Sie zwei Schritte: 1. Finden Sie die URL für die ReadMe.md-Datei in Raw-Version. Zum Beispiel eins: https://raw.githubusercontent.com/Anwar-Faiz/forkrap/master/README.md 2. Nun, wenn Sie serverseitig die Verwendung von file_gets_content etc. von PHP verwenden möchten, können Sie die URL laden. Wenn Sie jQuery verwenden möchten, können Sie Load() verwenden.

Beachten Sie auch, dass wenn Sie Quelle der Raw-URL-Seite anzeigen, nur Text angezeigt wird. Also, Sie müssen nicht viel Text-Parsing auch tun :) Dies ist eine gute Nachricht.

Weiter Sie unescape Funktionen oder Tools wie codebeautify verwenden können, um die Zeichen zu unescape, die mit dem Look and Feel Ihres HTML wie '<   "etc etc.