search

thomas11 / md-readme

Generate Markdown-formatted READMEs from your Emacs Lisp file headers.
15 stars 10 forks source link

Escape `'-quoted identifiers for use in Markdown #7

Closed NateEag closed 8 years ago

NateEag commented 8 years ago

Emacs Lisp's `identifier-quoting' does not play well with Markdown, since Markdown uses words-here to indicate inline code-style names.

By turning `name' into `name' as part of the rendering process, these identifier references look sane in the generated Markdown document.

Resolves issue #6.

NateEag commented 8 years ago

Question:

Do you think it's better to leave the elisp-style backtick quoting in the Markdown document, as I've done here, or to drop them?

Markdown's backtick quoting is fairly analogous to the elisp style, in that both call out the name as special, so maybe retaining the elisp-style quotes is redundant.

Thoughts?

thomas11 commented 8 years ago

Thanks Nate!

I've left the elisp backticks in there. They are somewhat redundant, but Emacs users are so used to them that it makes the identifiers stand out easily.

NateEag commented 8 years ago

Okay, makes sense.

Thanks for the merge (and for the package).