centrifuge / documentation

Documentation for Centrifuge
https://docs.centrifuge.io/
GNU Affero General Public License v3.0
15 stars 71 forks source link

Support LaTex formulas embedded in markdown using mathjax #128

Closed lucasvo closed 5 years ago

lucasvo commented 5 years ago

We'd like to be able to embed formulas into our markdown docs using MathJax similarly to how HackMD is doing it (e.g. https://hackmd.io/features#MathJax).

The following is an example of how formulas can be embedded in Markdown:

The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral

$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

Acceptance Criteria:

This issue has a gitcoin bounty attached to it. If you'd like to start working on it, feel free to reach out to me (lucas@centrifuge.io) directly, join our slack channel #bounties on our slack

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 300.0 DAI (300.0 USD @ $1.0/DAI) attached to it as part of the Centrifuge fund.

gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 6 days, 10 hours from now. Please review their action plans below:

1) eswarasai has started work.

Will try to closely replicate the HackMD handling for MathJax in the MD docs. Thanks!

Learn more on the Gitcoin Issue Details page.

eswarasai commented 5 years ago

@lucasvo - I've used KaTex instead of LaTex and seems to be working fine with the existing Gatsby setup as per mentioned here -- https://mdxjs.com/guides/math-blocks

I've created a PR with the above example rendered in Introduction which looks like below screenshot:

katex
gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work for 300.0 DAI (300.0 USD @ $1.0/DAI) has been submitted by:

  1. @eswarasai

@lucasvo please take a look at the submitted work:


gitcoinbot commented 5 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


The funding of 300.0 DAI (300.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @eswarasai.