be728e9c01
* feat: Add Mintlify docs * Fixed the mint.json for v2 * Fixed versioning issue * Add titles to ICS feed endpoints * Added errors to v1 * Added rate-limit to API v1 * feat: added v1-v2 differences and v1 auth * Trying to eliminate reasons for v1 not showing on publication * Used the swagger openapi validator * remove deprecated v1 endpoints * Moved api docs into new folders without api-reference * Renamed api to api-reference * removed the versioning * Got rid of anchor warnings * Fixed naming * Just as a test - using the same v2 openapi spec for v1 reference * Removed 'externalDocs' from v1 * Removed securitySchemes * Updated the diff between v1/v2 * Added v1 in front of /attendees to test * Moved paths up and removed externalDocs * Testing - Added content to the response * Reduced paths to 1 * Testing: anything at this point * Fixed validation * Moved the other .mdx files to see if that's disrupting something * Trying with a tab * Empty tags array * Added back servers field * Removed all other schemas * Removed v1 for now * Added platform docs * Language fixes * Added v1 back * add API V1 response for attendees * remove unnecessary endpoint docs in API V1 * Removing platform and API for now * Updated v2 openapi doc --------- Co-authored-by: Syed Ali Shahbaz <alishahbaz7@gmail.com>
89 lines
2.5 KiB
Plaintext
89 lines
2.5 KiB
Plaintext
---
|
|
title: 'Markdown Syntax'
|
|
description: 'Text, title, and styling in standard markdown'
|
|
icon: 'text-size'
|
|
---
|
|
|
|
## Titles
|
|
|
|
Best used for section headers.
|
|
|
|
```md
|
|
## Titles
|
|
```
|
|
|
|
### Subtitles
|
|
|
|
Best use to subsection headers.
|
|
|
|
```md
|
|
### Subtitles
|
|
```
|
|
|
|
<Tip>
|
|
|
|
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~ |
|
|
|
|
You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text.
|
|
|
|
You need to use HTML to write superscript and subscript text. That is, add `<sup>` or `<sub>` around your text.
|
|
|
|
| Text Size | How to write it | Result |
|
|
| ----------- | ------------------------ | ---------------------- |
|
|
| Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
|
|
| Subscript | `<sub>subscript</sub>` | <sub>subscript</sub> |
|
|
|
|
## Linking to Pages
|
|
|
|
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](/writing-content/text)` links to the page "Text" in our components section.
|
|
|
|
Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.
|
|
|
|
## Blockquotes
|
|
|
|
### Singleline
|
|
|
|
To create a blockquote, add a `>` in front of a paragraph.
|
|
|
|
> Dorothy followed her through many of the beautiful rooms in her castle.
|
|
|
|
```md
|
|
> Dorothy followed her through many of the beautiful rooms in her castle.
|
|
```
|
|
|
|
### Multiline
|
|
|
|
> Dorothy followed her through many of the beautiful rooms in her castle.
|
|
>
|
|
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
|
|
|
|
```md
|
|
> Dorothy followed her through many of the beautiful rooms in her castle.
|
|
>
|
|
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
|
|
```
|
|
|
|
### LaTeX
|
|
|
|
Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.
|
|
|
|
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
|
|
|
|
```md
|
|
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
|
|
```
|