Uploaded image for project: 'Maven Doxia'
  1. Maven Doxia
  2. DOXIA-492

Add support for doxia macros in markdown documents.

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.4
    • Fix Version/s: 1.7
    • Component/s: Module - Markdown
    • Labels:
      None

      Description

      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
         #`??MACRO_NAME MACRO_ARGS`
      
      • Inline
      `??MACRO_NAME MACRO_ARGS`
      

      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:

      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.

        Attachments

        1. maven-site-plugin-integration-test.patch
          0.9 kB
          Andreas Veithen
        2. screen.png
          39 kB
          Juergen Kellerer

          Issue Links

            Activity

              People

              • Assignee:
                hboutemy Hervé Boutemy
                Reporter:
                juergenk Juergen Kellerer
              • Votes:
                6 Vote for this issue
                Watchers:
                11 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: