Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

Comment tags are not recognized #299

Open
b-onc opened this issue Jun 7, 2021 · 3 comments
Open

Comment tags are not recognized #299

b-onc opened this issue Jun 7, 2021 · 3 comments

Comments

@b-onc
Copy link

b-onc commented Jun 7, 2021

Comment tags, such as Important, Note, Warning are not recognized and rendered as >.

Example:

/// Describes the ordering the messages are presented.
///
/// - Important: ⚠️ Changing this value doesn't trigger delegate methods. You should reload your UI manually after changing
/// the `listOrdering` value to reflect the changes. Further updates to the messages will be delivered using the delegate
/// methods, as usual.
///
public var listOrdering: ListOrdering = .topToBottom

rendered as:
image

and generated markdown:

### `listOrdering`

Describes the ordering the messages are presented.

``` swift
public var listOrdering: ListOrdering = .topToBottom 
\```

> 

(escaped the closing backticks of the code snippet intentionally)

@mattt
Copy link
Contributor

mattt commented Jun 9, 2021

@b-onc What version are you using? This should be in the latest release (1.0.0-rc.1) with #282

$ swift-doc --version

@DominikBucher12
Copy link

Hello @mattt ,

the PR you sent is currently working only for HTML style of documentation, however I didn't find anything in the PR that would be related to the output for markdown files. Could you please take a look into this issue?

Thank you very much

@mattt
Copy link
Contributor

mattt commented Jun 10, 2021

@DominikBucher12 Thanks for pointing this out. I can confirm that this isn't working as intended: https://github.com/SwiftDocOrg/SwiftMarkup/wiki/Callout_Delimiter

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants