From 5002912083f0d8578d7bca6640f6a04131f30611 Mon Sep 17 00:00:00 2001 From: Abhinav kumar <126642111+Abhinavcode13@users.noreply.github.com> Date: Thu, 25 Jul 2024 22:48:49 +0530 Subject: [PATCH] fix: adjust rendering for mdx files (#225) * fix: adjust spacing for mdx files * chores: fix auth * chores: minor fix * chores: fix spaces * chores: add ons --- content/components/accordions.mdx | 1 + content/components/code-groups.mdx | 1 + content/components/icons.mdx | 1 + development.mdx | 4 ++++ integrations/analytics/plausible.mdx | 1 + integrations/user-auth/choosing-an-auth-method.mdx | 2 ++ integrations/user-auth/overview.mdx | 1 - settings/navigation.mdx | 1 + settings/versioning.mdx | 1 + snippets/custom-subpath-gating.mdx | 1 + 10 files changed, 13 insertions(+), 1 deletion(-) diff --git a/content/components/accordions.mdx b/content/components/accordions.mdx index 4d17e879..626687d7 100644 --- a/content/components/accordions.mdx +++ b/content/components/accordions.mdx @@ -11,6 +11,7 @@ icon: 'square-caret-down' + ```jsx Accordion Example You can put any content in here. diff --git a/content/components/code-groups.mdx b/content/components/code-groups.mdx index 20069aec..c6e1b82a 100644 --- a/content/components/code-groups.mdx +++ b/content/components/code-groups.mdx @@ -29,6 +29,7 @@ class HelloWorld { + ````md Code Group Example diff --git a/content/components/icons.mdx b/content/components/icons.mdx index 5ee94993..fdb9ad40 100644 --- a/content/components/icons.mdx +++ b/content/components/icons.mdx @@ -7,6 +7,7 @@ icon: "icons" + ```jsx Icon Example ``` diff --git a/development.mdx b/development.mdx index 23b13e97..e1b0b8c6 100644 --- a/development.mdx +++ b/development.mdx @@ -15,6 +15,7 @@ Follow these steps to install and run Mintlify on your operating system: **Step 1**: Install Mintlify: + ```bash npm npm i -g mintlify ``` @@ -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: + ```bash npm npm i -g mintlify@latest ``` @@ -89,6 +91,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a + 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. @@ -96,6 +99,7 @@ We suggest using extensions on your IDE to recognize and format MDX. If you're a + Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. diff --git a/integrations/analytics/plausible.mdx b/integrations/analytics/plausible.mdx index 17b07c33..4d478842 100644 --- a/integrations/analytics/plausible.mdx +++ b/integrations/analytics/plausible.mdx @@ -5,6 +5,7 @@ title: "Plausible" Add your site's domain to `mint.json` to send analytics to Plausible. + Do not include `http://` or `https://` with your domain. diff --git a/integrations/user-auth/choosing-an-auth-method.mdx b/integrations/user-auth/choosing-an-auth-method.mdx index e319d4fe..2a26c533 100644 --- a/integrations/user-auth/choosing-an-auth-method.mdx +++ b/integrations/user-auth/choosing-an-auth-method.mdx @@ -12,6 +12,7 @@ Before your users can access personalized content, they must be authenticated. M + - 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. @@ -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` + - 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. diff --git a/integrations/user-auth/overview.mdx b/integrations/user-auth/overview.mdx index f032d344..a164ace0 100644 --- a/integrations/user-auth/overview.mdx +++ b/integrations/user-auth/overview.mdx @@ -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. diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 64b4e768..e18f68eb 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -173,6 +173,7 @@ would make a folder called `your-folder` containing an MDX file called ``` + ### Hidden Pages MDX files not included in `mint.json` will not show up in the sidebar but are diff --git a/settings/versioning.mdx b/settings/versioning.mdx index 9b59f0b4..1110a3ac 100644 --- a/settings/versioning.mdx +++ b/settings/versioning.mdx @@ -127,6 +127,7 @@ We do not recommend nesting versions inside of each other because it's hard to m + 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`. diff --git a/snippets/custom-subpath-gating.mdx b/snippets/custom-subpath-gating.mdx index 41ce54b7..24f8cb1c 100644 --- a/snippets/custom-subpath-gating.mdx +++ b/snippets/custom-subpath-gating.mdx @@ -1,4 +1,5 @@ + **Prerequisite**: Your primary domain (company.com) is hosted on Cloudflare and you are on the [Mintlify startup plan or above](https://mintlify.com/pricing).