penumbra icon indicating copy to clipboard operation
penumbra copied to clipboard

Installation docs fixes

Open kobigurk opened this issue 2 years ago • 4 comments

  1. pd requires clang to be installed to compile librocksdb-sys, missing from linux instructions in https://guide.penumbra.zone/main/pcli/install.html.

  2. weird latexing going on here: image

  3. missing $ sign in image

  4. Also in image

kobigurk avatar Apr 20 '22 18:04 kobigurk

I wonder whether the weird LaTeX behavior is related to the missing $ signs?

hdevalence avatar Apr 20 '22 18:04 hdevalence

@hdevalence I fixed the same issue on some of the other documentation pages but missed this -- katex is parsing any $ as a LaTeX special character and adding the span tags. The fix is that literal $ characters in documentation always need to be escaped: \$

zbuc avatar Apr 20 '22 18:04 zbuc

Hmm, even in code blocks ? That seems pretty suboptimal

hdevalence avatar Apr 20 '22 18:04 hdevalence

Yep. I tested locally and if I didn't have mdbook-katex installed, literal $ within a code block worked fine, but as soon as I installed mdbook-katex it'd need to be escaped.

zbuc avatar Apr 20 '22 18:04 zbuc