Skip to content

Commit 431067b

Browse files
authored
Merge branch 'main' into add_json_correctness_scorer
2 parents a2d7d21 + b0e8dcf commit 431067b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+3202
-165
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ wheels/
1717
.installed.cfg
1818
*.egg-info/
1919

20+
# APIs
21+
google-cloud-sdk/
2022
# PyInstaller
2123
# Usually these files are written by a python script from a template
2224
# before PyInstaller builds the exe, so as to inject date/other infos into it.

Pipfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ pandas = "*"
1616
openai = "*"
1717
together = "*"
1818
anthropic = "*"
19-
pytest = "*"
20-
pytest-asyncio = "*"
2119

2220
[dev-packages]
2321
pytest = "*"

docs/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Mintlify Starter Kit
2+
3+
Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
4+
5+
- Guide pages
6+
- Navigation
7+
- Customizations
8+
- API Reference pages
9+
- Use of popular components
10+
11+
### Development
12+
13+
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
14+
15+
```
16+
npm i -g mintlify
17+
```
18+
19+
Run the following command at the root of your documentation (where mint.json is)
20+
21+
```
22+
mintlify dev
23+
```
24+
25+
### Publishing Changes
26+
27+
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
28+
29+
#### Troubleshooting
30+
31+
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
32+
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`

docs/development.mdx

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: 'Development'
3+
description: 'Preview changes locally to update your docs'
4+
---
5+
6+
<Info>
7+
**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
8+
</Info>
9+
10+
Follow these steps to install and run Mintlify on your operating system:
11+
12+
**Step 1**: Install Mintlify:
13+
14+
<CodeGroup>
15+
16+
```bash npm
17+
npm i -g mintlify
18+
```
19+
20+
```bash yarn
21+
yarn global add mintlify
22+
```
23+
24+
</CodeGroup>
25+
26+
**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command:
27+
28+
```bash
29+
mintlify dev
30+
```
31+
32+
A local preview of your documentation will be available at `http://localhost:3000`.
33+
34+
### Custom Ports
35+
36+
By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
37+
38+
```bash
39+
mintlify dev --port 3333
40+
```
41+
42+
If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
43+
44+
```md
45+
Port 3000 is already in use. Trying 3001 instead.
46+
```
47+
48+
## Mintlify Versions
49+
50+
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
51+
52+
<CodeGroup>
53+
54+
```bash npm
55+
npm i -g mintlify@latest
56+
```
57+
58+
```bash yarn
59+
yarn global upgrade mintlify
60+
```
61+
62+
</CodeGroup>
63+
64+
## Validating Links
65+
66+
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
67+
68+
```bash
69+
mintlify broken-links
70+
```
71+
72+
## Deployment
73+
74+
<Tip>
75+
Unlimited editors available under the [Pro
76+
Plan](https://mintlify.com/pricing) and above.
77+
</Tip>
78+
79+
If the deployment is successful, you should see the following:
80+
81+
<Frame>
82+
<img src="/images/checks-passed.png" style={{ borderRadius: '0.5rem' }} />
83+
</Frame>
84+
85+
## Code Formatting
86+
87+
We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
88+
89+
## Troubleshooting
90+
91+
<AccordionGroup>
92+
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
93+
94+
This may be due to an outdated version of node. Try the following:
95+
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
96+
2. Upgrade to Node v19 or higher.
97+
3. Reinstall mintlify: `npm install -g mintlify`
98+
</Accordion>
99+
100+
<Accordion title="Issue: Encountering an unknown error">
101+
102+
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
103+
</Accordion>
104+
</AccordionGroup>
105+
106+
Curious about what changed in the CLI version? [Check out the CLI changelog.](https://www.npmjs.com/package/mintlify?activeTab=versions)

docs/essentials/code.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: 'Code Blocks'
3+
description: 'Display inline code and code blocks'
4+
icon: 'code'
5+
---
6+
7+
## Basic
8+
9+
### Inline Code
10+
11+
To denote a `word` or `phrase` as code, enclose it in backticks (`).
12+
13+
```
14+
To denote a `word` or `phrase` as code, enclose it in backticks (`).
15+
```
16+
17+
### Code Block
18+
19+
Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
20+
21+
```java HelloWorld.java
22+
class HelloWorld {
23+
public static void main(String[] args) {
24+
System.out.println("Hello, World!");
25+
}
26+
}
27+
```
28+
29+
````md
30+
```java HelloWorld.java
31+
class HelloWorld {
32+
public static void main(String[] args) {
33+
System.out.println("Hello, World!");
34+
}
35+
}
36+
```
37+
````

docs/essentials/images.mdx

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: 'Images and Embeds'
3+
description: 'Add image, video, and other HTML elements'
4+
icon: 'image'
5+
---
6+
7+
<img
8+
style={{ borderRadius: '0.5rem' }}
9+
src="https://mintlify-assets.b-cdn.net/bigbend.jpg"
10+
/>
11+
12+
## Image
13+
14+
### Using Markdown
15+
16+
The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code
17+
18+
```md
19+
![title](/path/image.jpg)
20+
```
21+
22+
Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.
23+
24+
### Using Embeds
25+
26+
To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images
27+
28+
```html
29+
<img height="200" src="/path/image.jpg" />
30+
```
31+
32+
## Embeds and HTML elements
33+
34+
<iframe
35+
width="560"
36+
height="315"
37+
src="https://www.youtube.com/embed/4KzFe50RQkQ"
38+
title="YouTube video player"
39+
frameBorder="0"
40+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
41+
allowFullScreen
42+
style={{ width: '100%', borderRadius: '0.5rem' }}
43+
></iframe>
44+
45+
<br />
46+
47+
<Tip>
48+
49+
Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility.
50+
51+
</Tip>
52+
53+
### iFrames
54+
55+
Loads another HTML page within the document. Most commonly used for embedding videos.
56+
57+
```html
58+
<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>
59+
```

docs/essentials/markdown.mdx

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: 'Markdown Syntax'
3+
description: 'Text, title, and styling in standard markdown'
4+
icon: 'text-size'
5+
---
6+
7+
## Titles
8+
9+
Best used for section headers.
10+
11+
```md
12+
## Titles
13+
```
14+
15+
### Subtitles
16+
17+
Best use to subsection headers.
18+
19+
```md
20+
### Subtitles
21+
```
22+
23+
<Tip>
24+
25+
Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
26+
27+
</Tip>
28+
29+
## Text Formatting
30+
31+
We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.
32+
33+
| Style | How to write it | Result |
34+
| ------------- | ----------------- | --------------- |
35+
| Bold | `**bold**` | **bold** |
36+
| Italic | `_italic_` | _italic_ |
37+
| Strikethrough | `~strikethrough~` | ~strikethrough~ |
38+
39+
You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text.
40+
41+
You need to use HTML to write superscript and subscript text. That is, add `<sup>` or `<sub>` around your text.
42+
43+
| Text Size | How to write it | Result |
44+
| ----------- | ------------------------ | ---------------------- |
45+
| Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
46+
| Subscript | `<sub>subscript</sub>` | <sub>subscript</sub> |
47+
48+
## Linking to Pages
49+
50+
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).
51+
52+
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.
53+
54+
Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.
55+
56+
## Blockquotes
57+
58+
### Singleline
59+
60+
To create a blockquote, add a `>` in front of a paragraph.
61+
62+
> Dorothy followed her through many of the beautiful rooms in her castle.
63+
64+
```md
65+
> Dorothy followed her through many of the beautiful rooms in her castle.
66+
```
67+
68+
### Multiline
69+
70+
> Dorothy followed her through many of the beautiful rooms in her castle.
71+
>
72+
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
73+
74+
```md
75+
> Dorothy followed her through many of the beautiful rooms in her castle.
76+
>
77+
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
78+
```
79+
80+
### LaTeX
81+
82+
Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.
83+
84+
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
85+
86+
```md
87+
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
88+
```

0 commit comments

Comments
 (0)