From dd477258a9e239e6cc28cc0ccdb100fb12f36af7 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Thu, 2 Oct 2025 21:35:54 +0300 Subject: [PATCH] docs(guide): document formatting equations --- .../Note Types/Text/Math Equations.html | 20 +++++++++++-------- .../User Guide/Scripting/Logging.html | 6 +++--- .../Note Types/Text/Math Equations.md | 18 +++++++++++------ 3 files changed, 27 insertions(+), 17 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html index dd41d19ab..598f08cc7 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Math Equations.html @@ -6,12 +6,6 @@ the button from the Formatting toolbar (generally found under the Insert buttons).

-

If inserting equations frequently, using the Ctrl+M keyboard - shortcut can be more comfortable. Alternatively, type $$ or \[ to - trigger the popup directly.

-

There is currently no quick way to insert an equation, such as surrounding - it with $ or pressing Ctrl+M on an already - typed-out equation.

The mathematical expression must be written in the TeX format. There is no visual editor for the math equations, only a preview. 

Enabling Display mode will render the equation slightly bigger @@ -19,6 +13,12 @@ center it. Display mode equations will act as blocks (i.e. like paragraphs, or tables) and can be inserted for example in lists. Non-display equations can be part of the text.

+

Keyboard shortcuts

+

If inserting equations frequently, using the Ctrl+M keyboard + shortcut can be more comfortable. Alternatively, type $$ or \[ to + trigger the popup directly.

+

There is currently no quick way to turn an already typed-out equation, + such as surrounding it with $ or pressing Ctrl+M.

Supported math features

Technically we are using the KaTeX library which allows for a subset of the TeX format. To see the full list of supported features, consult the @@ -27,8 +27,12 @@ the official documentation.

Markdown support

Math equations will be preserved when exporting to or importing from Markdown, - surrounded by \( characters for inline math expressions, and $\) for + surrounded by $ characters for inline math expressions, and $$ for display mode.

If you notice any issue with the Markdown import/export for equations, feel free to report it while providing - the equation that causes issues.

\ No newline at end of file + the equation that causes issues.

+

Formatting the equation

+

It is possible to customize the font size and foreground color for both + inline and display-mode equations, just like any other text. For inline + equations, the background color/highlight can also be adjusted.

\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Logging.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Logging.html index 8cf47c2c7..c7db77f63 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Logging.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Scripting/Logging.html @@ -16,9 +16,9 @@

For logs that are not directly visible to the user, the standard console.log can be used as well.

\ No newline at end of file diff --git a/docs/User Guide/User Guide/Note Types/Text/Math Equations.md b/docs/User Guide/User Guide/Note Types/Text/Math Equations.md index 0bcb5af7a..c8cfa94e5 100644 --- a/docs/User Guide/User Guide/Note Types/Text/Math Equations.md +++ b/docs/User Guide/User Guide/Note Types/Text/Math Equations.md @@ -3,20 +3,26 @@ Within text notes, it's possible to enter mathematical equations using the button from the Formatting toolbar (generally found under the Insert buttons). -If inserting equations frequently, using the Ctrl+M keyboard shortcut can be more comfortable. Alternatively, type `$$` or `\[` to trigger the popup directly. - -There is currently no quick way to insert an equation, such as surrounding it with `$` or pressing Ctrl+M on an already typed-out equation. - The mathematical expression must be written in the TeX format. There is no visual editor for the math equations, only a preview.  Enabling _Display mode_ will render the equation slightly bigger (especially if using big operators such as summation, or fractions) and center it. Display mode equations will act as blocks (i.e. like paragraphs, or tables) and can be inserted for example in lists. Non-display equations can be part of the text. +## Keyboard shortcuts + +If inserting equations frequently, using the Ctrl+M keyboard shortcut can be more comfortable. Alternatively, type `$$` or `\[` to trigger the popup directly. + +There is currently no quick way to turn an already typed-out equation, such as surrounding it with `$` or pressing Ctrl+M. + ## Supported math features Technically we are using the KaTeX library which allows for a subset of the TeX format. To see the full list of supported features, consult the [Supported Functions](https://katex.org/docs/supported) and the [Support Table](https://katex.org/docs/support_table) from the official documentation. ## Markdown support -Math equations will be preserved when exporting to or importing from Markdown, surrounded by `\(` characters for inline math expressions, and `$\)` for display mode. +Math equations will be preserved when exporting to or importing from Markdown, surrounded by `$` characters for inline math expressions, and `$$` for display mode. -If you notice any issue with the Markdown import/export for equations, feel free to [report](../../Troubleshooting/Reporting%20issues.md) it while providing the equation that causes issues. \ No newline at end of file +If you notice any issue with the Markdown import/export for equations, feel free to [report](../../Troubleshooting/Reporting%20issues.md) it while providing the equation that causes issues. + +## Formatting the equation + +It is possible to customize the font size and foreground color for both inline and display-mode equations, just like any other text. For inline equations, the background color/highlight can also be adjusted. \ No newline at end of file