Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there a hidden option to not escape backticks? #73

Open
metaleap opened this issue Sep 14, 2019 · 1 comment
Open

Is there a hidden option to not escape backticks? #73

metaleap opened this issue Sep 14, 2019 · 1 comment

Comments

@metaleap
Copy link

metaleap commented Sep 14, 2019

Loving this, here's my Vsxmd-generated result .md: https://github.com/metaleap/vscode-appz/tree/master/libs/cs#readme

Wondering if I can pass through all backticks without them getting backslash-escaped as currently happens. These are bindings being generated for various languages (C# being merely one of many) from a .d.ts IDL. So its source doc-comments are reused for all generated code in the appropriate target language syntax and these however do contain "code" formatting with backticks already, also because the major doc scenarios for the audience will be VS-Code hover-tips and markdown files, those generated doc-comments are further slightly augmented by backticks for method param names etc. (you can see those incorporate inside the <summary> — with the benefit of them showing up in VSCode hover-tips, unlike <param> which are still also generated)

Of course I could add a post-build sed step but... 😄

@metaleap
Copy link
Author

metaleap commented Sep 14, 2019

Well, I figured out one way to do this via .csproj addition like so, given sed is locally in $PATH:

  <Target Name="ReadmeMdUnescapeBackticks" AfterTargets="Build" BeforeTargets="Publish">
    <Exec Command="sed -i 's/\\`/`/g' $(DocumentationMarkdown)" />
  </Target>

Neat! Feel free to close, the above works for me as a hacky workaround.

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

No branches or pull requests

1 participant