Skip to content

Updated mathematical formula support for content blocks #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ You need:

## How to contribute

First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
> [!IMPORTANT]
> First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).

- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide).
- 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.
Expand Down Expand Up @@ -133,7 +134,8 @@ make get-source

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

**Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!
> [!TIP]
> **Want to author new code samples?** Refer to our [Jupyter Notebook template Quickstart](https://github.com/validmind/validmind-library/tree/main/notebooks/templates)!

<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
18 changes: 13 additions & 5 deletions site/guide/model-documentation/work-with-content-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,23 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener

### Add mathematical formulas

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

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

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

![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%}
- To insert the equation inline, leave **Display mode** untoggled.
- To insert the equation on its own line, toggle **Display mode** on.

3. Click **Insert** to add the equation to your content block.
::: {.column-margin}
![Equation preview in the formula editor](equation-preview.png){fig-alt="A screenshot showing the equation preview in the formula editor" .screenshot group="latex"}

:::

![The two formula display modes](formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"}

3. Click **[{{< fa check >}}]{.green}** to add the equation to your content block.

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

Expand Down
Loading