Redback-Operations / redback-documentation

Docusaurus instance for Redback Operations documentation
MIT License
1 stars 54 forks source link

Include remark-math and rehype-katex plugins #103

Closed Cnalhcal closed 1 week ago

Cnalhcal commented 1 week ago

Hello, This is less an issue and more a feature request. Would it be possible to have the remark-math and rehype-katex modules included in this docusaurus instance? As more and more of the data science work comes in it'd be nice to be able to render inline LaTeX in the documentation.

I tried running it in my own fork but couldn't get it to work (although to be honest I'm rubbish at javascript and the whole node ecosystem so thats not too surprising).

Anyway would greatly appreciate some math typesetting support. Docusaurus official documentation for it is here: https://docusaurus.io/docs/markdown-features/math-equations Thanks!

SassafrasAU commented 1 week ago

Heya, I can definitely add these on, will do later tonight / early tomorrow depending on other work

SassafrasAU commented 1 week ago

Just added - https://github.com/Redback-Operations/redback-documentation/commit/c2caed3a479f468f02050ee2ce0fa9ba0802ecdb

Proof of concept page here, will restructure this with changes to documentation handover stuff. Feel free to make your own guide if that's something you feel like doing

Cnalhcal commented 1 week ago

Cheers!!!