[
https://issues.apache.org/jira/browse/DOXIA-617?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17650034#comment-17650034
]
Herve Boutemy commented on DOXIA-617:
-------------------------------------
I tried to describe everything in one schema:
[https://maven.apache.org/plugins/maven-site-plugin/history.html]
what you need to understand is that rendering one markup source (be it
Markdown, Asciidoc, apt, xdoc, ...) to html just renders the page content: it
does not provide the site menu, nor site header nor site footer
recent work from Michael on
https://issues.apache.org/jira/browse/MSHARED-480?focusedCommentId=17643783&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17643783
makes that more visible
It's the task of maven-site-plugin though maven-site-renderer to "decorate" the
main page content with a site "decoration", ie a site left menu, site top
header, ...
Then we need to check these metadata both at immediate Doxia parsing and
initial rendering, then once it is integrated into a site content
> doxia-module-markdown: Add support for --- header section marks
> ---------------------------------------------------------------
>
> Key: DOXIA-617
> URL: https://issues.apache.org/jira/browse/DOXIA-617
> Project: Maven Doxia
> Issue Type: Improvement
> Components: Module - Markdown
> Reporter: Bertrand Martin
> Priority: Major
>
> h1. Use Case
> It is "generally" accepted that document header metadata in Markdown (like
> _title_, _author_, etc.) must be specified inside a header section, delimited
> with 3 hypens:
> {noformat}
> ---
> title: My Doc Title
> author: Myself
> keywords: great,doc
> ---
> # Introduction
> ...
> {noformat}
> See:
> * https://bookdown.org/yihui/rmarkdown/html-document.html
> * https://pandoc.org/MANUAL.html#extension-yaml_metadata_block
> * https://github.com/vsch/flexmark-java/wiki/Extensions#yaml-front-matter
> Currently, the only supported syntax for document header metadata is the very
> same as above, but *without* the 3 hypens marking the header section:
> {noformat}
> title: My Doc Title
> author: Myself
> keywords: great,doc
> # Introduction
> ...
> {noformat}
> h1. Specification
> Enable the YAML Front Matter Extension of Flexmark so that such header is
> processed automatically (nothing to code here!)
> Keep the default behavior (we want backward compatibility) with the parsing
> of metadatas (which won't be affected by the YAML Front Matter parsing).
> h1. Doc
> Update the documentation on how to use Markdown in Doxia. This feature
> (document metadata) is currently not documented.
> We should have a small guide on how to use Markdown in Doxia, and its
> specific features (metadatas, macros, etc.)
> h1. Test
> Add corresponding unit tests and integration tests (for both old and new
> syntaxes)
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
