search

CocoaPods / cocoapods-acknowledgements

CocoaPods plugin that generates a plist which includes the installation metadata
MIT License
111 stars 17 forks source link

Parse Podspec.description as Markdown #2

Closed orta closed 9 years ago

orta commented 10 years ago

Even in the simple example we have someone using markdown in the long description.

marcelofabri commented 9 years ago

@orta: can you give more details about this?

orta commented 9 years ago

The description attribute in the Podspec supports markdown, right now we are putting raw markdown in to the acknowledgements bundle, but ideally it should be pre-parsed so that people don't have to have a markdown parser in their CocoaPods dependencies.

marcelofabri commented 9 years ago

Should we parse to html? Or just strip the markdown annotations?

Are the answers the same for both formats (the new plist and the one for Settings.bundle)?

orta commented 9 years ago

Great questions. Settings bundles can't show HTML, so that ideally should be stripped. The new plists are probably showing in webviews, so I think rendering those as HTML should be :+1:

RedCarpet seems to be able to deal with both case - so it may be an option :+1:

marcelofabri commented 9 years ago

I've created a PR (#15), but I remembered that we don't show the description inside a settings bundle, so I didn't have to strip it.

Is description the only Podspec field that supports Markdown? I haven't found this info in the guides.