Skip to content

Commit

Permalink
fix: adjust rendering for mdx files (mintlify#225)
Browse files Browse the repository at this point in the history
* fix: adjust spacing for mdx files

* chores: fix auth

* chores: minor fix

* chores: fix spaces

* chores: add ons
  • Loading branch information
Abhinavcode13 authored Jul 25, 2024
1 parent ca60a28 commit 5002912
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions content/components/accordions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ icon: 'square-caret-down'
</Accordion>

<RequestExample>

```jsx Accordion Example
<Accordion title="I am an Accordion.">
You can put any content in here.
Expand Down
1 change: 1 addition & 0 deletions content/components/code-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class HelloWorld {
</CodeGroup>

<RequestExample>

````md Code Group Example
<CodeGroup>

Expand Down
1 change: 1 addition & 0 deletions content/components/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ icon: "icons"
<Icon icon="check" size={32} />

<RequestExample>

```jsx Icon Example
<Icon icon="check" size={32} />
```
Expand Down
4 changes: 4 additions & 0 deletions development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Follow these steps to install and run Mintlify on your operating system:
**Step 1**: Install Mintlify:

<CodeGroup>

```bash npm
npm i -g mintlify
```
Expand Down Expand Up @@ -52,6 +53,7 @@ Port 3000 is already in use. Trying 3001 instead.
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:

<CodeGroup>

```bash npm
npm i -g mintlify@latest
```
Expand Down Expand Up @@ -89,13 +91,15 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a

<AccordionGroup>
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>

This may be due to an outdated version of node. Try the following:
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
2. Upgrade to Node v19 or higher.
3. Reinstall mintlify: `npm install -g mintlify`
</Accordion>

<Accordion title="Issue: Encountering an unknown error">

Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
</Accordion>
</AccordionGroup>
1 change: 1 addition & 0 deletions integrations/analytics/plausible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: "Plausible"
Add your site's domain to `mint.json` to send analytics to Plausible.

<Info>

Do not include `http://` or `https://` with your domain.
</Info>

Expand Down
2 changes: 2 additions & 0 deletions integrations/user-auth/choosing-an-auth-method.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Before your users can access personalized content, they must be authenticated. M

<Tabs>
<Tab title="Shared Session">

- You have a dashboard or other user portal hosted at your domain.
- Your users' session credentials are stored as cookies.
- You can create a new API endpoint at the same origin or a subdomain of your dashboard.
Expand All @@ -22,6 +23,7 @@ Before your users can access personalized content, they must be authenticated. M
- If your dashboard is at `*.foo.com`, your **docs** must be hosted at `foo.com` or `*.foo.com`
</Tab>
<Tab title="JWT">

- You have some existing login flow.
- You can add a final step in this login flow that creates a JWT and redirects to the docs.
</Tab>
Expand Down
1 change: 0 additions & 1 deletion integrations/user-auth/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ User Auth is an enterprise feature. {
### Prefilling API Keys
If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground.
{/*
### Showing/Hiding Pages
By default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata.
Expand Down
1 change: 1 addition & 0 deletions settings/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ would make a folder called `your-folder` containing an MDX file called
```

</CodeGroup>

### Hidden Pages

MDX files not included in `mint.json` will not show up in the sidebar but are
Expand Down
1 change: 1 addition & 0 deletions settings/versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ We do not recommend nesting versions inside of each other because it's hard to m
</Accordion>

<Accordion title="Missing Pages" icon="circle-exclamation">

If you add versions to your docs and the pages disappeared from your
navigation, make sure you spelled the version the same as in your `versions`
array in `mint.json`.
Expand Down
1 change: 1 addition & 0 deletions snippets/custom-subpath-gating.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<Info>

**Prerequisite**: Your primary domain (company.com) is hosted on Cloudflare
and you are on the [Mintlify startup plan or
above](https://mintlify.com/pricing).
Expand Down

0 comments on commit 5002912

Please sign in to comment.