녹 문서에 수학 공식을 쓰는 방법은 무엇입니까?

Question

내 크레이트 용 Rust 문서에 수학 공식을 쓰고 싶습니다. ,

내 수식에 일부를 사용하고 싶습니다,하지만 불행히도 :

/// $ 2^8 $ 

이 같은 렌더링 : 적어도 power 작품으로 LaTeX의 기본 지원이있을 것 같은데 이 작동하지 않습니다

/// $ \frac{x}y $ 

Answer 1

이 THER 것 같은데 e는 LaTeX의 기본 지원입니다.

별로 없습니다. LaTeX가 아닌 Markdown에 대한 지원이 있습니다. Stack Overflow는 Markdown을 지원하지만 다른 풍미를 지원합니다. 예 : a^b => a^b, 그러나 a<sup>b</sup> => a ^b. Markdown은 임의의 LaTeX를 지원하지 않습니다. 사실, 당신의 예제 :

/// Hi 
/// 
/// $ 2^8 $ 
pub fn what() { 

} 

여전히 $ 포함 뭔가 생성 :

다음으로 좋은 것은 미리 렌더링 이미지를 생성하고 대신 문서에 포함 할 수 있습니다를, 그러나 an open issue은 이미지를 다른 곳에 호스팅하지 않는 한 현재 가능하지 않음을 나타냅니다.

an issue to support MathJax in rustdoc도 있었지만 닫혔습니다.

Answer 2

MathJax와 rustdoc의 --html-in-header을 사용하여 필요한 스크립트 태그에 대한 링크를 전달할 수 있습니다. 이것은 매우 해킹되어 docs.rs에서 작동하지 않지만 자신의 문서를 호스팅하는 경우 작동 할 수 있습니다.