Skip to content

text rendering as emojis in strings generated docs #242

Closed
@wyardley

Description

@wyardley

Describe the Bug

Certain strings (e.g., .erlang::repo::apt::erlang_solutions) are rendered without being backtick escaped in certain places (headings, default values), and show up as emojis in rendered docs, as seen in
thttps://github.com/voxpupuli/puppet-erlang/blob/master/REFERENCE.md

image

Expected Behavior

The string is rendered without emojis

Steps to Reproduce

Steps to reproduce the behavior:

  1. Create documentation with a parameter that will produce an emoji (see examples)
  2. Use Puppet strings to generate docs
  3. ???
  4. Profit

Environment

  • n/a

Additional Context

https://stackoverflow.com/questions/50657698/how-can-i-stop-github-from-rendering-emojis-in-markdown covers some of the possible workarounds. Wrapping in backticks should work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions