Wie markdown (.md-Dateien in html-Dateien

Angenommen ich habe eine README.md Datei in einem github-repository. Ich bin dann eine website alles über das repository, dass ich host mit gh-pages.

Was ich will, ist, um einen Abschnitt meiner index.html Datei, bekommt seine Inhalte aus meinem README.md - Datei. Auf diese Weise wird nur eine Datei aktualisiert werden muss.

Ich kann mir vorstellen, dass die markdown-Datei zuerst konvertiert werden müssen, um html, und html kann dann in eine andere html-Datei.

Ich habe mir in HTML5-Imports, aber Sie sind derzeit nur unterstützt in Chrome. Mit einem separaten .js - Datei mit document.write() nützlich sein könnte, aber es ist eine einfache, saubere Art und Weise?

Sie können die Verwendung von XMLHttpRequest und innerHTML-Funktion oder wenn Sie der Verwendung von jQuery, die Sie verwenden können, laden-Funktion. stackoverflow.com/questions/17636528/...
Ich würde gehen mit ausführen jekyll lokal.... es ist das, was gh-Seiten erfolgt auf Ihr Ende als gut. aber durch das lokal läuft, können Sie auch plugins etc. das tut, was Sie wollen...
Sollten Sie eine ausführliche Antwort mit jekyll, wie Sie vorgeschlagen. Die detaillierte Node.js Lösung von @gliemezis unten geschrieben gut aussieht. Es verwendet die marked NPM-Paket.
Hier ist eine Lösung, die verwendet jekyll: stackoverflow.com/questions/15214762/...

InformationsquelleAutor gliemezis | 2016-06-12

  1. 9

    Meine komplette Antwort mit Node.js

    1. Installieren Sie zuerst die marked markdown-Konverter:

    $ npm install --save-dev marked

    2. Dann in eine neue Datei namens generateReadMe.js kompilieren Sie die markdown-zu-HTML-und schreiben Sie es auf eine neue README.html Datei:

    var marked = require('marked');
var fs = require('fs');

var readMe = fs.readFileSync('README.md', 'utf-8');
var markdownReadMe = marked(readMe);

fs.writeFileSync('./site/README.html', markdownReadMe);

    3. Dann innerhalb der index.html wo die README.md Inhalte gewünscht wird, fügen Sie ein <object> tag:

    <object data="README.html" type="text/html"></object>

    4. Dann führen Sie diesen Befehl an der Befehlszeile, um Sie geschehen:

    $ node path/to/generateReadMe.js


    Der ganze Prozess war ziemlich einfach und schmerzlos. Ich fügte hinzu, die ganze Sache zu meinem npm start Skript. Jetzt jedes mal, wenn ich eine änderung an meiner README.md - Datei, die Veränderungen registrieren, die auf meinem gh-pages-website.

    Ich habe mehrere Probleme mit diesem marked - Konvertierung, einschließlich, aber nicht beschränkt auf, so dass alle internen links nutzlos. Im Gegensatz zu Git, Markdown-Methode, die zusätzlich die folgenden Anker-header-tags <a id="user-content-header-title" class="anchor" href="#header-title" aria-hidden="true"> diese Konvertierung nur noch eine id in den header <h3 id="header-name">. Das war wirklich störend für mich. Ich bin sicher, ich bin nicht allein in dieser Einschätzung der situation mit dieser Methode. Ich schlage vor, einen Blick hier.
    Ich sehe. Die Schritte 1, 2 und 4 von dieser Lösung ersetzt werden könnte, mit entsprechenden änderungen für die Verwendung von ruby-und GitHub - markup, oder andere tools zum konvertieren einer .md - Datei in HTML. Schritt 3 ist der wichtige Teil der Antwort auf diese konkrete Frage.

    InformationsquelleAutor gliemezis

  2. 2

    Konvertieren von markdown zu html, die Sie verwenden können, eine Konvertierung Bibliothek oder ein Kommando-tool. Ein Beispiel für die Verwendung der Ruby-Sprache, besuchen Sie: https://github.com/github/markup.

    Versuchen Sie eine Suche für eine adäquate Umsetzung der Bibliothek, oder command tool für Ihre Umsetzung, indem Sie: https://www.npmjs.com/search?q=markup. Die akzeptierte Antwort oben ist ein Beispiel für die Verwendung der NPM package manager für die Node.js.

    Eine weitere option ist das jekyll: stackoverflow.com/questions/15214762/....

    InformationsquelleAutor oklas

  3. 2

    Könnte man eine markdown-parser wie https://github.com/markdown-it/markdown-it zu konvertieren, die markdown in html.

    Entweder Sie konvertieren die markdown auf dem server, und führen Sie Sie in das HTML an den client ausgeliefert werden, oder verwenden Sie es zu laden, die markdown in dem browser und konvertieren es.

    Ich denke, das ist eine andere Node.js Lösung (über das NPM package manager). Die akzeptierte Antwort ist besser, denn es hat detaillierte Schritte.

    InformationsquelleAutor Sudsy

Schreibe einen Kommentar