-
-
Notifications
You must be signed in to change notification settings - Fork 408
Open
Description
Yard supports meta tags in textual documents. For instance, one could be annotated as follows:
# @title The Document Title
# @author The Author Name
The problem is that this special markup breaks output outside Yard, i.e. in GitHub. In Markdown, a regular HTML comment can be used to workaround this problem:
<!--
# @title The Document Title
# @author The Author Name
-->
However, in AsciiDoc nothing helps.
Attempt 1: HTML comments
<!--
# @title The Document Title
# @author The Author Name
-->
All works correct in Yard. However, outside Yard HTML tags are escaped, which results with even uglier output:
Attempt 2: AsciiDoc comments
////
# @title The Document Title
# @author The Author Name
////
Document looks good both in Yard and outside it, but document title remains unchanged (equals to file name).
Attempt 3: AsciiDoc conditional processing
ifndef::env-browser,env-github[]
# @title The Document Title
# @author The Author Name
endif::[]
Document looks good in Yard, but its title remains unchanged.
Metadata
Metadata
Assignees
Labels
No labels