You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Hervé Boutemy (JIRA)" <ji...@apache.org> on 2019/01/22 09:22:00 UTC

[jira] [Commented] (DOXIA-584) Support rewriting multiple page documentation crosslinks from .md to .html

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

Hervé Boutemy commented on DOXIA-584:
-------------------------------------

looks like a good idea.
And it could even be generalized to any Doxia parser, since it's usually not that easy for users to imagine that a link from one markup page to another has to be written with a .html extension instead of the original source extension
but let's start with Markdown, we'll see later the generalization

are you able/interested in providing a PR to https://github.com/apache/maven-doxia ?

> Support rewriting multiple page documentation crosslinks from .md to .html
> --------------------------------------------------------------------------
>
>                 Key: DOXIA-584
>                 URL: https://issues.apache.org/jira/browse/DOXIA-584
>             Project: Maven Doxia
>          Issue Type: New Feature
>          Components: Module - Markdown
>    Affects Versions: 1.7, 1.8
>            Reporter: Josep Monés Teixidor
>            Priority: Major
>
> Doxia markdown module doesn't seem to be able to convert links to other markdown files, to links to the converted html files, by rewriting them. As a result, it cannot generate sets of crosslinked markdown files.
> There's a need for this feature (including myself), as it can be seen in the following stack overflow question: https://stackoverflow.com/questions/36708241/getting-doxia-module-markdown-to-rewrite-md-links
> The current workaround suggested in this stackoverflow is using markdown-page-generator-plugin instead (a different generation plugin), that has an option called {{transformRelativeMarkdownLinks}}. This still seems to be valid for doxia-module-markdown 1.8. 
> {{markdown-page-generator-plugin}} can also provide some example on how to implement this. It seems to implement {{LinkResolver}}. See [https://github.com/walokra/markdown-page-generator-plugin/blob/master/src/main/java/com/ruleoftech/markdown/page/generator/plugin/FlexmarkLinkResolver.java]
>  
> Setting this rewrite as an option, as {{markdown-page-generator-plugin}} does, seems sensitive as some documentations may legitimately link to Markdown files. If options want to be avoided, I suggest that rewrite is enabled only for relative links.
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)