docs: render governing equations natively on GitHub#2
Merged
Conversation
Add the eight headline governing equations as GitHub-native $$ display math in the README Governing Equations section, so they render on the repo page instead of only inside docs/equations.html. LaTeX is taken verbatim from docs/equations.html. Also add an htmlpreview link to the full rendered reference.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GitHub displays
docs/equations.htmlas raw source, so the governing equations were not visible on the repository page.This PR adds the eight headline governing equations to the README Governing Equations section as GitHub-native
$$ ... $$display math, which GitHub renders inline. The LaTeX is taken verbatim fromdocs/equations.html(no equation or constant added or altered). A link to the full rendered MathJax reference via htmlpreview.github.io is also added near the top of the section.Equations added (8): Fourier heat conduction, Philip-de Vries moisture transport, Butler-Volmer kinetics, Faraday wall loss, Strang operator splitting, Tikhonov inverse problem, Monte Carlo PoF, and API 579-1 Level 2 Option B FAD curve.
Existing plaintext blocks are kept intact.