Tweak Markdown avec Java flexmark-java

En ce qui concerne le processeur Markdown, je pense qu'il existe des bibliothèques relativement bien connues en Perl (famille principale) / Python / Ruby / JavaScript, etc., mais en ce qui concerne Java, je n'en ai pas entendu beaucoup (ou plutôt standard). Je n'ai rien) je ressens.

État actuel (2017-03-02) En regardant à travers le processeur Java Markdown trouvé en open-source, il est toujours en développement actif et semble être satisfaisant en termes de fonctionnalité et de vitesse flexmark-java Je l'ai touché un peu, donc c'est une introduction légère.

Présentation de la bibliothèque Java Markdown

• flexmark-java
• Il est basé sur commonmark-java décrit plus loin, mais il a été considérablement étendu.
• Actuellement en développement actif.
• commonmark-java
• Fabriqué par Atlassian.
• Une forme d'implémentation de CommonMark qui est née dans une tentative de normaliser en quelque sorte les spécifications de Markdown, qui regorge de dialectes.
• pegdown
• Même si l'atmosphère était populaire jusqu'à il y a quelque temps, la fin de la vie a été officiellement déclarée.
• • "Au lieu de cela, je vous suggère de vous tourner vers @vsch's flexmark-java, ... On dit aussi que c'est "*.
• markedj
• Port Java de marqué.js, qui est célèbre pour JavaScript.
• GitBucket Créé par le projet.
• Markdown4j
• La version finale (2.2) était le 12/01/2013 et a été placée dans Google Code (arrêtée).
• Il semble qu'il ne soit plus maintenu.
• Il existe plusieurs clones sur GitHub.
• MarkdownJ
• La dernière mise à jour du code lui-même date du 19/02/2014, et il semble qu'elle n'est pas bien entretenue.
• MarkdownPapers
• Bien qu'il ait été mis à jour relativement récemment (2016-03-17), il semble s'être arrêté.
• Txtmark
• 2015-07-23 Dernière mise à jour.

flexmark-java facts

• Il a commencé à partir de commonmark-java le 02/06/2016 fork.
• Utilisé autour de XWiki, Lucene ) A été fait.
• Il semble que le développement ait commencé pour une utilisation avec un plug-in tel qu'IntelliJ appelé Markdown Navigator. [Source requise]

Markdown Melancholy et extension flexmark-java

Markdown est célèbre pour avoir de nombreux dialectes comme mentionné ci-dessus, mais c'est presque la même chose, et j'aimerais le couvrir avec une seule implémentation si possible. Ainsi flexmark-java couvre de nombreux dialectes en le rendant étendu (type de plug-in?).

// https://github.com/vsch/flexmark-java/wiki/Exemple d'utilisation modifiée

import com.vladsch.flexmark.ast.Node;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.parser.Parser;
import com.vladsch.flexmark.parser.ParserEmulationProfile;
import com.vladsch.flexmark.util.options.MutableDataHolder;
import com.vladsch.flexmark.util.options.MutableDataSet;

import com.vladsch.flexmark.ext.abbreviation.AbbreviationExtension;
import com.vladsch.flexmark.ext.definition.DefinitionExtension;
import com.vladsch.flexmark.ext.footnotes.FootnoteExtension;
import com.vladsch.flexmark.ext.tables.TablesExtension;
import com.vladsch.flexmark.ext.typographic.TypographicExtension;

public class RenderingExamples {

    //Définir les options pour chaque dialecte Markdown
    private MutableHolder getOptions(String type) {
        MutableDataHolder options = new MutableDataSet();
        switch (type) {
            case "markdown":
                options.setFrom(ParserEmulationProfile.MARKDOWN);
                break;
            case "multimarkdown":
                options.setFrom(ParserEmulationProfile.MULTI_MARKDOWN);
                break;
            case "kramdown":
                options.setFrom(ParserEmulationProfile.KRAMDOWN);
                options.set(Parser.EXTENSIONS, Arrays.asList(
                    AbbreviationExtension.create(),
                    DefinitionExtension.create(),
                    FootnoteExtension.create(),
                    TablesExtension.create(),
                    TypographicExtension.create()
                    ));
                break;
         }
         return options;
    }

    //Générer un analyseur pour chaque dialecte
    private Parser getParser(String type) {
        switch (type) {
            case "commonmark":
                return Parser.builder().build();
            default:
                return Parser.builder(getOptions(type)).build();
        }
    }

    //Générer un moteur de rendu pour chaque dialecte
    private HtmlRenderer getHtmlRenderer(String type) {
        switch (type) {
            case "commonmark":
                return HtmlRenderer.builder().build();
            default:
                return HtmlRenderer.builder(getOptions(type)).build();
        }
    }

    //Rendu HTML!
    public String render(String markdownText, String type) {
        Node document = getParser(type).parse(markdownText);
        return getHtmlRenderer(type).render(document);
    }
}

Je veux jouer avec Markdown moi-même

Il semble qu'il existe également un moyen pour les frères de jouer seuls avec le Node analysé.

// https://github.com/vsch/flexmark-java/wiki/Exemple d'utilisation modifiée

import com.vladsch.flexmark.ast.Node;
import com.vladsch.flexmark.ast.NodeVisitor;
import com.vladsch.flexmark.ast.Text;
import com.vladsch.flexmark.ast.VisitHandler;

public class NodeVisitingExamples {
    public NodeVisitingExamples() {
        this.visitor = new NodeVisitor(
            new VisitHandler<>(Text.class, NodeVisitingExamples.this::visit)
        );
    }

    public void traverse(String markdownText) {
        Parser parser = Parser.builder().build();
        this.visitor.visit(parser.parse(markdownText));
    }

    private void visit(Text text) {
        System.out.println(text);
    }

    private final NodeVisitor visitor;
}

Je veux écrire une extension moi-même

(Ajout si vous vous sentez comme ça)

J'ai utilisé mon pegdown!

Explication de la méthode de migration: https://github.com/vsch/flexmark-java/wiki/Pegdown-Migration

Plus de détails

Officiel: https://github.com/vsch/flexmark-java/wiki/Usage

Exemple de code

https://gist.github.com/dmikurube/630b82f437977501a415155e3df3d68c