You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,8 @@ You need:
26
26
27
27
## How to contribute
28
28
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).
30
31
31
32
- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide).
32
33
- 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
133
134
134
135
After you pull in the changes, commit them to this repo as part of the release notes process.
135
136
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)!
137
139
138
140
<!-- September 16, 2024: Need to mention rendered Python `.html` docs and generated `.md` test descriptions -->
Copy file name to clipboardExpand all lines: site/guide/model-documentation/work-with-content-blocks.qmd
+13-5Lines changed: 13 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -63,15 +63,23 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener
63
63
64
64
### Add mathematical formulas
65
65
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:
67
67
68
-
1. Click **√** in the toolbar while editing a content block.
68
+
1. Click **$f(x)$** in the toolbar while editing a content block.
69
69
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:
71
71
72
-
{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.
73
74
74
-
3. Click **Insert** to add the equation to your content block.
75
+
::: {.column-margin}
76
+
{fig-alt="A screenshot showing the equation preview in the formula editor" .screenshot group="latex"}
77
+
78
+
:::
79
+
80
+
{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.
75
83
76
84
### Generate Text with AI <sup>[beta]{.smallcaps}</sup>
0 commit comments