Skip to content

Yard's meta data make AsciiDoc render ugly when used outside Yard #1192

@skalee

Description

@skalee

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:

zrzut ekranu 2018-09-15 o 10 53 34

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

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions