Hi Folks,

I see some README.md files have been modified with asciidoctor metadata for 
when JBake bake the files, the files will have its metadata ported but on the 
other hand, Github does not render the those correctly because of this "~~~~~~" 
added to separate metadata and the content of the file. If you take a look on 
this [README.md](https://github.com/apache/tomee/tree/master/examples/applet) 
file you can see that all content of the file is inside of a grey box making 
the reading uncomfortable.

It seems that the only way to add hidden metadata to a README.md file supported 
by Github is adding the standard HTML comment.

README.md file:
<!---
title: Awesome Title
--->
After baking:
title: Awesome Title
~~~~~~

Github documentation does not describe a way to add hidden metadata.
https://help.github.com/categories/writing-on-github/

See the differences:
http://tomee.apache.org/examples/applet.html
https://github.com/apache/tomee/tree/master/examples/applet

I'm wondering if would be nice to wrap the metadata with the standard HTML 
comment and make the proper changes in tomee-site-generator project to handle 
this and have both documentations with a nice layout and add the mandatory 
metadata files to the [Github example 
page](https://github.com/apache/tomee/tree/master/examples).

Any thoughts?

Best Regards,
José Henrique Ventura.

Sent with [ProtonMail](https://protonmail.com) Secure Email.

Reply via email to