maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Masatake Iwasaki (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DOXIA-492) Add support for doxia macros in markdown documents.
Date Mon, 23 Nov 2015 08:55:11 GMT

    [ https://issues.apache.org/jira/browse/DOXIA-492?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15021770#comment-15021770
] 

Masatake Iwasaki commented on DOXIA-492:
----------------------------------------

I tried it out by installing trunk of maven-site-plugin which depends on doxia-1.7-SNAPSHOT.
{noformat}
$ svn co http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin maven-site-plugin
$ cd maven-site-plugin
$ mvn install -DskipTests

$ svn co http://svn.apache.org/viewvc/maven/doxia/doxia/trunk doxia
$ cd doxia
$ mvn install -DskipTests
{noformat}

Then I fixed the pom.xml of my product to update the version of maven-site-plugin to 3.4.1-SNAPSHOT
and did {{mvn site}}. I got expected result after I added the fix [~veithen] proposed.

> Add support for doxia macros in markdown documents.
> ---------------------------------------------------
>
>                 Key: DOXIA-492
>                 URL: https://issues.apache.org/jira/browse/DOXIA-492
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Module - Markdown
>    Affects Versions: 1.4
>            Reporter: Juergen Kellerer
>         Attachments: screen.png
>
>
> It would be nice if doxia macros could be supported also inside markdown documents (similar
to APT).
> Existing macros (especially snippet) is very useful, however with the power of maven
there's the ability to register own macros for a build process which enables reuse of resources
and improves dryness in general.
> A syntax which may work could be the following:
> * Block Level
> {noformat}
>    #`??MACRO_NAME MACRO_ARGS`
> {noformat}
> * Inline
> {noformat}
> `??MACRO_NAME MACRO_ARGS`
> {noformat}
> Reference: http://hackage.haskell.org/packages/archive/yesod-markdown/0.0/doc/html/Yesod-Markdown-Macros.html
> E.g. using "Texts" it works just from the Editor:
> !screen.png!
> When macros are not interpreted, they fallback to a code block, thus it's easy to edit
these sort of documents with one of the existing nice markdown editors.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message