Skip to content

feat!: render_docs() renders to gfm output#332

Draft
etiennebacher wants to merge 2 commits into
mainfrom
render-gfm
Draft

feat!: render_docs() renders to gfm output#332
etiennebacher wants to merge 2 commits into
mainfrom
render-gfm

Conversation

@etiennebacher
Copy link
Copy Markdown
Owner

@etiennebacher etiennebacher commented Jul 14, 2025

Fixes #331. Apart from extra spaces, it seems that this affects equations and symbols.

In roxygen2 syntax:

#' Some code with weird symbols: `pl$when(condition)` and `pl$then(output)`
#'
#' Some equations: \eqn{\partial Y / \partial X = a + \varepsilon/2}

In Rd file:

Some code with weird symbols: \code{pl$when(condition)} and \code{pl$then(output)}

Some equations: \eqn{\partial Y / \partial X = a + \varepsilon/2}

render_docs() before:

"Some code with weird symbols: <code>pl$when(condition)</code> and"              
"<code>pl$then(output)</code>"  

"Some equations: ∂*Y*/∂*X* = *a* + *ε*/2"       

render_docs() after:

"Some code with weird symbols: <code>pl\\$when(condition)</code> and"            
"<code>pl\\$then(output)</code>"        

"Some equations: $\\partial Y / \\partial X = a + \\varepsilon/2$"         

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

Successfully merging this pull request may close these issues.

Footnotes in mkdocs?

1 participant