Improve supported functions documentation #1511
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1511 +/- ##
======================================
Coverage 84.1% 84.1%
======================================
Files 79 79
Lines 4561 4561
Branches 804 804
======================================
Hits 3836 3836
Misses 630 630
Partials 95 95Continue to review full report at Codecov.
|
ronkok
left a comment
ronkok
left a comment
There was a problem hiding this comment.
@ylemkimon Thank you for this work. It significantly upgrades the page and I see nothing here that I wish to change.
There are some remaining issues and if you know ways to fix them, please feel free to do so. The issues:
\notis not working properly. I suspect that is because the CSS and JS of this page are not in sync.- There is excess padding in the environment table.
- Nested
$delimiters do not work - The "|" character cannot be used inside a table, which makes it impossible to demonstrate the
{c|c}argument to the{array}environment.
|
@ronkok Thank you for the review! The excessive padding is because the table is vertically aligned by the baseline, |
| @@ -0,0 +1,30 @@ | |||
| module.exports = function(md, options) { | |||
There was a problem hiding this comment.
Please add a top-level comment to this file explain its purpose.
| |:---------------------|:---------------------|:---------------------|:----- | ||
| |$\text{\'{a}}$ `\'{a}`|$\text{\~{a}}$ `\~{a}`|$\text{\.{a}}$ `\.{a}`|$\text{\H{a}}$ `\H{a}` | ||
| |$\text{\`{a}}$ `\`{a}`|$\text{\={a}}$ `\={a}`|$\text{\"{a}}$ `\"{a}`|$\text{\v{a}}$ `\v{a}` | ||
| |$\text{\`{a}}$ <code>\\`{a}</code>|$\text{\={a}}$ `\={a}`|$\text{\"{a}}$ `\"{a}`|$\text{\v{a}}$ `\v{a}` |
There was a problem hiding this comment.
Is the double backslash necessary here?
| |$[ ]$ `[ ]` |$\lbrack~\rbrack$ `\lbrack`<br>$~~~~$`\rbrack`|$⌊~⌋$ `⌊ ⌋`|$\lfloor~\rfloor$ `\lfloor`<br>$~~~~$`\rfloor` |$\downarrow$ `\downarrow` | ||
| |$\{ \}$ `\{ \}`|$\lbrace \rbrace$ `\lbrace`<br>$~~~~$`\rbrace`|$⎰⎱$ `⎰⎱` |$\lmoustache \rmoustache$ `\lmoustache`<br>$~~~~$`\rmoustache`|$\updownarrow$ `\updownarrow` | ||
| |$⟨~⟩$ `⟨ ⟩` |$\langle~\rangle$ `\langle`<br>$~~~~$`\rangle`|$⟮~⟯$ `⟮ ⟯`|$\lgroup~\rgroup$ `\lgroup`<br>`\rgroup` |$\Uparrow$ `\Uparrow` | ||
| |$\vert$ $\colorbox{#f3f3f4}{\textbar}$ |$\vert$ `\vert` |$┌ ┐$ `┌ ┐`|$\ulcorner \urcorner$ `\ulcorner`<br>$~~~~$`\urcorner` |$\Downarrow$ `\Downarrow` |
There was a problem hiding this comment.
Why were we using \colorbox before?
There was a problem hiding this comment.
@kevinbarabash I was unable to use the | character inside a table. Even when inside backticks, the Remarkable parser treated the character as a cell separator. The \colorbox was my attempt to simulate the appearance of a code string, since in it I could use \textbar.
@ylemkimon's use of <code> tags is much better.
| |$\in$ `\in` |$\mid$ `\mid` |$\to$ `\to`|$\implies$ `\implies` | ||
| |$\notin$ `\notin` |$\land$ `\land`|$\gets$ `\gets` |$\impliedby$ `\impliedby` | ||
| |$\ni$ `\ni` |$\lor$ `\lor` |$\leftrightarrow$ `\leftrightarrow`|$\iff$ `\iff` | ||
| |$\notni$ `\notni` || | |
There was a problem hiding this comment.
Thanks for cleaning up these stray |. We should maybe look at adding a linter for our markdown to catch these things.
| |$~$ | `\providecommand\macroname[numargs]{definition}` | ||
|
|
||
| Macros can also be defined in the KaTeX [rendering options](./options). | ||
| Macros can also be defined in the KaTeX [rendering options](options.md). |
There was a problem hiding this comment.
Good call on making all links use .md.
|
@ronkok Maybe you could open a new issue with those points, so it's easier to track them. |
4 participants
<code></code><code>and HTML entity code