ansible-doctor icon indicating copy to clipboard operation
ansible-doctor copied to clipboard

Email link for the author such as in the example doesn't work

Open dan-wittenberg opened this issue 3 years ago • 1 comments

If you put the markdown around the author name/email it doesn't render anything into the README.md

dan-wittenberg avatar Sep 08 '22 05:09 dan-wittenberg

Thanks for reporting! That's because the annotation value contains a : which is also used as delimiter in the annotation itself. I don't know how to handle this case properly, but in the meantime you can use a full qualified annotation:

# @meta author:value: [John Doe](https://blog.example.com)

xoxys avatar Sep 08 '22 07:09 xoxys

I having what I think is a similar issue where on a multi line annotation it doesn't properly render indentation. Would it be possible to implement an escape character that would allow you to denote that it isn't being used as a delimiter?

darkdecoy avatar Oct 24 '22 16:10 darkdecoy

Can you give an example please? This issue sounds a bit different.

xoxys avatar Oct 24 '22 18:10 xoxys

When create annotation like...

# @meta author: >
# Wazuh
#
# ### Based on previous work from dj-wasabi
#
#   https://github.com/dj-wasabi/ansible-ossec-server
# @end

It produces the following...

## Author

Wazuh

### Based on previous work from dj-wasabi

https://github.com/dj-wasabi/ansible-ossec-server

with the link not being indented by two spaces even though I put them there

darkdecoy avatar Oct 25 '22 18:10 darkdecoy

That's an unrelated issue, and we currently don't support indentations.

xoxys avatar Jan 20 '23 11:01 xoxys