gbdev / gbdev/pandocs

Use math notation where appropriate

Open
#441 0 comments 1 reaction 0 assignees View on GitHub
consistency - style enhancement
Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Description

Math notation support using [MathML](https://developer.mozilla.org/en-US/docs/Web/MathML) will be merged as part of #350.

Once that's done, complex math notation should be rendered using that when inline text is hard to read; compare:

![image](https://user-images.githubusercontent.com/15271137/194751024-c3ad0708-c000-4b96-ac95-2570a9730973.png)
![image](https://user-images.githubusercontent.com/15271137/194751053-c25988a8-b669-42e1-bd19-5605754d4978.png)

It's clear that math notation is preferable as soon as there is special notation (powers, fractions, indices, etc.), but should it be preferred for inline text as well? Example:

https://github.com/gbdev/pandocs/blob/ae89342abe259502402247e268db2912ab848314/src/OAM.md?plain=1#L88-L90

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.