Comment inclure de démarque (.md) les fichiers dans les fichiers html

Supposons que j'ai un README.md fichier dans un répertoire github. Je suis ensuite faire un site tout à propos de ce référentiel que je vais hôte à l'aide de gh-pages.

Ce que je veux, c'est avoir une section de mon index.html fichier qui tire son contenu de mon README.md fichier. De cette façon, un seul fichier doit être mis à jour.

J'imagine que la minoration de fichiers doivent d'abord être convertis au format html, et que le html peuvent être mis dans un autre fichier html.

J'ai regardé dans HTML5 Importations, mais ils ne sont actuellement pris en charge dans le navigateur Chrome. En utilisant un .js fichier avec document.write() pourrait être utile, mais est-il un simple, propre chemin?

Vous pouvez utiliser XMLHttpRequest et innerHTML fonction ou si vous utilisez jQuery, vous pouvez utiliser la fonction de charge. stackoverflow.com/questions/17636528/...
J'irais avec l'exécution de la jekyll au niveau local.... c'est ce que gh-pages n'sur leur fin. mais en exécutant localement, vous pouvez inclure des plugins etc. qu'est-ce que vous voulez...
Vous devez soumettre une réponse détaillée à l'aide de jekyll, comme vous l'avez suggéré. Le détail Node.js solution par @gliemezis affichés ci-dessous a l'air bon. Il utilise le marked package NPM.
Voici une solution qui utilise jekyll: stackoverflow.com/questions/15214762/...

OriginalL'auteur gliemezis | 2016-06-12

  1. 9

    Ma réponse complète à l'aide de Node.js

    1. Tout d'abord installer le marked markdown converter:

    $ npm install --save-dev marked

    2. Puis dans un nouveau fichier appelé generateReadMe.js, compiler le markdown en HTML et de les écrire sur une nouvelle README.html fichier:

    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. Puis à l'intérieur de la index.html où la README.md contenu désiré, ajouter un <object> tag:

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

    4. Ensuite l'exécuter sur la ligne de commande pour la réaliser:

    $ node path/to/generateReadMe.js


    L'ensemble du processus est assez simple et indolore. J'ai ajouté de l'ensemble de la chose à mon npm start script. Désormais, chaque fois que je fais un changement à mon README.md fichier, l'enregistrer sur mon gh-pages de site web.

    J'ai trouvé plusieurs problèmes avec cette marked de conversion, y compris mais non limité à, tous les liens internes inutiles. Contrairement à la Git Démarque de la méthode, ce qui ajoute à la suite d'ancrage de balises d'en-tête <a id="user-content-header-title" class="anchor" href="#header-title" aria-hidden="true">, cette conversion n'ajoute un id à l'en-tête <h3 id="header-name">. C'était vraiment gênant pour moi. Je suis sûr que je ne suis pas la seule dans cette évaluation de la situation avec cette méthode. Je suggère de jeter un oeil ici.
    Je vois. Les étapes 1, 2 et 4 de cette solution pourrait être remplacé par des modifications appropriées pour l'utilisation de ruby et de GitHub marquage, ou tout autre outil pour convertir un .md un fichier au format HTML. L'étape 3 est la pièce importante de la réponse à cette question spécifique.

    OriginalL'auteur gliemezis

  2. 3

    Vous pouvez utiliser un abattement analyseur tels que https://github.com/markdown-it/markdown-it pour convertir le format markdown en html.

    Vous pouvez soit convertir la démarque sur le serveur et de les intégrer dans le code HTML livré au client, ou de l'utiliser pour charger la démarque dans le navigateur et de le convertir.

    Je pense que c'est un autre Node.js solution (via le mécanisme national de prévention le gestionnaire de package). La accepté de répondre le mieux, car il a détaillé les étapes.

    OriginalL'auteur Sudsy

  3. 2

    Pour convertir le format markdown en html, vous pouvez utiliser une bibliothèque de conversion ou d'une commande de l'outil. Pour un exemple d'utilisation de la langue Ruby, visitez: https://github.com/github/markup.

    Essayer à la recherche d'une bibliothèque de conversion ou de commande de l'outil de mise en œuvre en visitant: https://www.npmjs.com/search?q=markup. L'on a accepté la réponse ci-dessus est un exemple d'utilisation de la NGP gestionnaire de package pour Node.js.

    Une autre option est de jekyll: stackoverflow.com/questions/15214762/....

    OriginalL'auteur oklas