繁体   English   中英

使用高级 Markdown 生成 Maven 站点?

[英]Maven site generation using advanced Markdown?

我们在Maven 生成的站点中使用 Markdown 。 奇迹般有效。 AFAIK 该插件在后台使用Flexmark ,它支持Admonition 扩展

我们也想使用它们,信息框对文档很有帮助。 我们在pom.xml中的站点配置如下所示:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.8.2</version>
</plugin>

我们如何配置它来识别额外的 markdown?

这个问题有点老了,但我一直在尝试解决这个问题,以便将 Gitlab 扩展用于数学方程,简短的回答是我认为你不能开箱即用。

maven-site-plugin 使用 markdown 的doxia-module-markdown模块,该模块在内部使用 Flexmark,但它预先配置了用于此目的的扩展。

这是代码的链接和来自的确切片段

// Initialize the Flexmark parser and renderer, once and for all
static
{
    MutableDataSet flexmarkOptions = new MutableDataSet();

    // Enable the extensions that we used to have in Pegdown
    flexmarkOptions.set( com.vladsch.flexmark.parser.Parser.EXTENSIONS, Arrays.asList(
            EscapedCharacterExtension.create(),
            AbbreviationExtension.create(),
            AutolinkExtension.create(),
            DefinitionExtension.create(),
            TypographicExtension.create(),
            TablesExtension.create(),
            WikiLinkExtension.create(),
            StrikethroughExtension.create()
    ) );

// ...
}

我认为您可以分叉这个项目,添加您需要的扩展,并将其作为依赖项添加到 maven-site-plugin,它可能会像这样工作:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.8.2</version>
    <dependencies>
        <dependency>
            <groupId>${my-forked-groupId}</groupId>
            <artifactId>${my-forked-artifactId}</artifactId>
            <version>${my-forked-version}</version>
        </dependency>
    </dependencies>
</plugin>

在我看来,这不太理想,我可能会探索其他(非 Maven)选项来获得我正在寻找的结果,但可能会在第二天左右尝试这个,如果我让它工作我'将发送代码链接,以防其他人从中受益。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM