Existe-t-il un utilitaire de ligne de commande pour rendre le format Markdown à la sauce GitHub ?

Question

Je me demande s'il y a un utilitaire de ligne de commande pour prendre un Markdown à la sauce GitHub et le rendre en HTML.

J'utilise un wiki GitHub pour créer le contenu d'un site Web. J'ai cloné le référentiel sur mon serveur et j'aimerais ensuite le transformer en HTML normal. Il est important pour moi que ce qui apparaît sur GitHub corresponde exactement à ce qui doit être affiché sur mon site Web. J'aimerais également utiliser les blocs clôturés avec les éléments suivants ~~~ Je préfère donc ne pas utiliser uniquement la syntaxe Markdown standard.

J'ai regardé un peu dans le JavaScript live preview pensant que je pourrais l'accrocher dans Node.js, mais ils disent qu'il est déprécié. J'ai regardé le dépôt redcarpet, mais il ne semble pas y avoir d'interface en ligne de commande.

J'ai proposé ma propre solution, mais comme aucune solution n'est clairement meilleure que les autres, je vais laisser la question sans réponse choisie.

Answer 1

J'ai écrit un petit CLI en Python et ajouté le support GFM. Il s'appelle Grip (aperçu instantané du Readme de Github) .

Installez-le avec :

$ pip install grip

Et pour l'utiliser, tout simplement :

$ grip

Alors, visitez localhost:5000 pour visualiser le readme.md à cet endroit.

Vous pouvez également spécifier votre propre fichier :

$ grip CHANGES.md

Et changer de port :

$ grip 8080

Et bien sûr, le rendu spécifique de Markdown à la sauce GitHub, avec éventuellement le contexte du dépôt :

$ grip --gfm --context=username/repo issue.md

Caractéristiques notables :

• Rendre les pages pour qu'elles apparaissent exactement comme sur GitHub
• Blocs clôturés
• API Python
• Naviguer entre les fichiers liés (merci, vladwing !) ajouté en 2.0
• Exportation vers un seul fichier (merci, iliggio !) ajouté en 2.0
• Nouveau : Lire à partir de stdin et l'exporter vers stdout ajouté en 3.0

J'espère que cela aidera quelqu'un ici. Consultez le site .

Answer 2

Je n'ai pas trouvé de méthode simple et rapide pour le format Markdown à la sauce GitHub, mais j'ai trouvé une version un peu plus générique Pandoc . Il convertit de/vers un certain nombre de formats, notamment Markdown, Rest, HTML et autres.

J'ai également développé un Makefile pour convertir tous les fichiers .md en .html (en grande partie grâce à l'exemple du site Rédaction, Markdown et Pandoc ) :

# 'Makefile'
MARKDOWN = pandoc --from gfm --to html --standalone
all: $(patsubst %.md,%.html,$(wildcard *.md)) Makefile

clean:
    rm -f $(patsubst %.md,%.html,$(wildcard *.md))
    rm -f *.bak *~

%.html: %.md
    $(MARKDOWN) $< --output $@

Answer 3

pip3 install --user markdown
python3 -m markdown readme.md > readme.html

Il ne gère pas les extensions GitHub, mais c'est mieux que rien. Je pense que vous pouvez étendre le module pour gérer les ajouts de GitHub.

Answer 4

Peut-être que ceci pourrait aider :

gem install github-markdown

Il n'existe pas de documentation, mais je l'ai obtenu à partir de l'adresse suivante gollum documentation. En regardant rubydoc.info il semble que vous puissiez l'utiliser :

require 'github/markdown'  
puts GitHub::Markdown.render_gfm('your markdown string')

dans votre code Ruby. Vous pouvez facilement envelopper cela dans un script pour le transformer en un utilitaire de ligne de commande :

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

puts GitHub::Markdown.render_gfm File.read(ARGV[0])

Exécutez-le avec ./render.rb path/to/my/markdown/file.md . Notez que ce n'est pas sûr pour une utilisation en production sans désinfection.

Answer 5

Ce n'est probablement pas ce que vous voulez, mais puisque vous avez mentionné Node.js : je n'ai pas pu trouver un bon outil pour prévisualiser la documentation Markdown à la sauce GitHub sur mon disque local avant de la commettre sur GitHub, alors aujourd'hui j'en ai créé un, basé sur Node.js : https://github.com/ypocat/gfms

Vous pouvez donc peut-être réutiliser le showdown.js de celui-ci pour votre Wiki, si votre question est toujours d'actualité. Sinon, peut-être que d'autres personnes confrontées au même problème que moi trouveront (tout comme moi) cette question et sa réponse.