Skip to content

Fixed nits in text page #647

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fixed nits in text page #647

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1691795
Documentation edits made through Mintlify web editor
baell Apr 11, 2025
212df6f
Documentation edits made through Mintlify web editor
baell Apr 11, 2025
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
30 changes: 16 additions & 14 deletions text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Headers and Text"
description: "Text, title, and styling in standard markdown"
icon: 'heading'
icon: "heading"
---

## Titles
Expand All @@ -21,20 +21,18 @@
```

<Tip>

Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.

Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
</Tip>

## Text Formatting

We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.

| Style | How to write it | Result |
| ------------- | ----------------- | --------------- |
| Bold | `**bold**` | **bold** |
| Italic | `_italic_` | _italic_ |
| Strikethrough | `~strikethrough~` | ~strikethrough~ |
| Style | How to write it | Result |
| ------------- | ----------------- | ----------------- |
| Bold | `**bold**` | **bold** |
| Italic | `_italic_` | _italic_ |
| Strikethrough | `~strikethrough~` | ~~strikethrough~~ |

You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text.

Expand All @@ -49,7 +47,7 @@

You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).

Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/content/text)` links to the page "Text" in our components section.
Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/text)` links to the page ["Text"](/text#linking-to-pages) in our components section.

Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.

Expand Down Expand Up @@ -81,11 +79,15 @@

### LaTeX

Mintlify supports in-line [LaTeX](https://www.latex-project.org) by surrounding your LaTeX code with dollar signs (\$). For example, `$(a^2 + b^2 = c^2)$` will render as $(a^2 + b^2 = c^2)$.
Mintlify supports in-line [LaTeX](https://www.latex-project.org) by surrounding your LaTeX code with dollar signs ($$). For example, \`$$

Equations on their own line can be created with double dollar signs (\$\$):
(a^2 \+ b^2 = c^2)$\` will render as $$(a^2 \\\+ b^2 = c^2)$$

$$\exists \, x \notin [0,1]$$
.

Equations on their own line can be created with double dollar signs ($$):

$$\\\\exists \\\\, x \\\\notin [0,1]$$

```md
$$\exists \, x \notin [0,1]$$
Expand All @@ -93,7 +95,7 @@

### Line Breaks

Markdown syntax also recognizes a double enter in your MDX as a linebreak.

Check warning on line 98 in text.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

text.mdx#L98 

Did you really mean 'linebreak'?

```html
<br />
Expand All @@ -103,4 +105,4 @@
Paragraph 1

Paragraph 2
```
```