search

prisms-center / phaseField

PRISMS-PF: An Open-Source Phase-Field Modeling Framework
https://prisms-center.github.io/phaseField/
Other
229 stars 119 forks source link

Switch to Allen-Cahn documentation to markdown #263

Closed landinjm closed 1 month ago

landinjm commented 1 month ago

I spent about 5 minutes to switch the Allen-Cahn latex documentation to markdown.

It's pretty straightforward since we take the latex equations and wrap them with $$ to make them markdown compatible.

@david-montiel-t can you take a look to make sure the formatting looks good?

landinjm commented 1 month ago

Seems that the last two equations do not display correctly on GitHub, although they display correctly with VSCode's markdown viewer.

Maybe the underbraces aren't supported?

landinjm commented 1 month ago

Should be fixed. The underbrace latex command is not supported.