Skip to content

Commit f315a49

Browse files
authored
Updated mathematical formula support for content blocks (#631)
* README tweak * Edited math formula instructions
1 parent 29c9373 commit f315a49

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ You need:
2626

2727
## How to contribute
2828

29-
First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
29+
> [!IMPORTANT]
30+
> First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
3031
3132
- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide).
3233
- If you create new documentation, make sure to add it to the [`_quarto.yml`](https://github.com/validmind/documentation/blob/main/site/_quarto.yml) file.
@@ -133,7 +134,8 @@ make get-source
133134

134135
After you pull in the changes, commit them to this repo as part of the release notes process.
135136

136-
**Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
137+
> [!TIP]
138+
> **Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
137139
138140
<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
139141

Loading
Loading
Binary file not shown.

site/guide/model-documentation/work-with-content-blocks.qmd

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,23 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener
6363

6464
### Add mathematical formulas
6565

66-
While editing a simple text block, you can insert math equations using the editor:
66+
While editing a simple text block, you can insert math equations using the formula editor:
6767

68-
1. Click **** in the toolbar while editing a content block.
68+
1. Click **$f(x)$** in the toolbar while editing a content block.
6969

70-
2. You can use the interface to type out the equation, or paste in a LaTeX formula:
70+
2. Enter your LaTeX formula in the text box and confirm that the Equation preview generates as expected:
7171

72-
![Inserting a mathematical formula using LaTex within a simple text block](mathtype-full-demo.gif){width=100% fig-alt="An animation that shows how to insert a mathematical formula using LaTex within a simple text block" .screenshot width=90%}
72+
- To insert the equation inline, leave **Display mode** untoggled.
73+
- To insert the equation on its own line, toggle **Display mode** on.
7374

74-
3. Click **Insert** to add the equation to your content block.
75+
::: {.column-margin}
76+
![Equation preview in the formula editor](equation-preview.png){fig-alt="A screenshot showing the equation preview in the formula editor" .screenshot group="latex"}
77+
78+
:::
79+
80+
![The two formula display modes](formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"}
81+
82+
3. Click **[{{< fa check >}}]{.green}** to add the equation to your content block.
7583

7684
### Generate Text with AI <sup>[beta]{.smallcaps}</sup>
7785

0 commit comments

Comments
 (0)