diff --git a/advanced/subpath/cloudflare.mdx b/advanced/subpath/cloudflare.mdx index 763b44eda..6c87fe0dc 100644 --- a/advanced/subpath/cloudflare.mdx +++ b/advanced/subpath/cloudflare.mdx @@ -7,46 +7,13 @@ import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx"; -## Create Cloudflare Worker +## Quick Setup -Navigate to the `Workers & Pages > Create application > Create worker`. You -should be able to presented with the following screen where you can create a new -Cloudlfare worker. +1. Create a new Worker in Cloudflare's `Workers & Pages` dashboard. - - Create a Cloudflare worker - +2. Add your custom domain in the worker's `Settings > Triggers > Add Custom Domain` section. Add both `www` and non-`www` versions of your domain. -### Add custom domain - -Once the worker is created, click `Configure worker`. Navigate to the worker -`Settings > Triggers`. Click on `Add Custom Domain` to add your desired domain -into the list - we recommend you add both the version with and without `www.` -prepended to the domain. - - - Cloudflare worker custom domain - - -If you have trouble setting up a custom subdirectory, -[contact our support team](mailto:sales@mintlify.com) and we'll walk you through -upgrading your hosting with us. - -### Edit Worker Script - -Click on `Edit Code` and add the following script into the worker's code. - - - Cloudflare edit code - - - - Edit `DOCS_URL` by replacing `[SUBDOMAIN]` with your unique subdomain and - `CUSTOM_URL` with your website's base URL. - +3. In the worker's code editor, paste the following script: ```javascript addEventListener("fetch", (event) => { @@ -80,5 +47,10 @@ async function handleRequest(request) { } ``` -Click on `Deploy` and wait for the changes to propagate (it can take up to a few -hours). + + Replace `[SUBDOMAIN]` with your Mintlify subdomain and `[YOUR_DOMAIN]` with your website's base URL. + + +4. Click `Deploy` and wait for the changes to propagate (this may take a few hours). + +Need help? [Contact our support team](mailto:sales@mintlify.com) for assistance with custom subdirectory setup. \ No newline at end of file diff --git a/advanced/user-auth/oauth.mdx b/advanced/user-auth/oauth.mdx index 98251eb9f..97cc68538 100644 --- a/advanced/user-auth/oauth.mdx +++ b/advanced/user-auth/oauth.mdx @@ -1,41 +1,44 @@ --- title: 'OAuth 2.0' -description: 'Integrate with your OAuth server to enable user login via the PKCE flow' +description: 'Enable user login via OAuth PKCE flow' --- -If you have an existing OAuth server that supports the PKCE flow, you can integrate with Mintlify for a seamless login experience. +Integrate your OAuth server with Mintlify to enable secure user authentication using the PKCE flow. -## Implementation +## Setup Steps - - Create an API endpoint that can be accessed with an OAuth access token, and responds with a JSON payload following the [UserInfo](./sending-data) format. Take note of the scope or scopes required to access this endpoint. + + Set up an API endpoint that: + - Accepts an OAuth access token + - Returns user data in the [UserInfo](./sending-data) format + - Defines required access scopes - - Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication), select the OAuth option, and fill out the required fields: - - - **Authorization URL**: The base URL for the authorization request, to which we will add the appropriate query parameters. - - **Client ID**: An ID for the OAuth 2.0 client to be used. - - **Scopes**: An array of scopes that will be requested. - - **Token URL**: The base URL for the token exchange request. - - **Info API URL**: The endpoint that will be hit to retrieve user info. + + In your [Mintlify dashboard](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication): + - Select OAuth authentication + - Fill in: + - Authorization URL + - Client ID + - Required scopes + - Token URL + - Info API URL - - Copy the Redirect URL listed in the [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and add it as an authorized redirect URL for your OAuth server. + + Add the Redirect URL from your Mintlify dashboard to your OAuth server's authorized redirects. -## Example - -I have an existing OAuth server that supports the PKCE flow. I want to set up authentication for my docs hosted at `foo.com/docs`. - -To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify’s specification. +## Example Configuration -I then go to the Mintlify dashboard settings, navigate to the User Auth settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint: -- **Authorization URL**: `https://auth.foo.com/authorization` -- **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH` -- **Scopes**: `['docs-user-info']` -- **Token URL**: `https://auth.foo.com/exchange` -- **Info API URL**: `https://api.foo.com/docs/user-info` +```json +{ + "authorizationUrl": "https://auth.foo.com/authorization", + "clientId": "ydybo4SD8PR73vzWWd6S0ObH", + "scopes": ["docs-user-info"], + "tokenUrl": "https://auth.foo.com/exchange", + "infoApiUrl": "https://api.foo.com/docs/user-info" +} +``` -Finally, I copy the Redirect URL displayed in the dashboard settings and add it as an authorized redirect URL in my OAuth client configuration settings. +This example shows a configuration for docs hosted at `foo.com/docs` with a user info endpoint at `api.foo.com/docs/user-info` requiring the `docs-user-info` scope. \ No newline at end of file diff --git a/advanced/user-auth/shared-session.mdx b/advanced/user-auth/shared-session.mdx index d2925a269..1fe467fad 100644 --- a/advanced/user-auth/shared-session.mdx +++ b/advanced/user-auth/shared-session.mdx @@ -1,50 +1,43 @@ --- title: 'Shared Session Auth' -description: 'Seamlessly share user sessions between your dashboard and your docs' +description: 'Share user sessions between your dashboard and docs' --- -This method utilizes the session authentication info already stored in your user’s browser to create a seamless documentation experience. +Share your existing user sessions from your dashboard with your documentation for seamless authentication. -## Implementation +## Setup - - Create an API endpoint that uses session authentication to identify users, and responds with a JSON payload following the [UserInfo](./sending-data) format. - - If the API domain does not *exactly match* the docs domain: - - Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`) - - Ensure your API’s `Access-Control-Allow-Credentials` header is `true` - - These CORS options only need to be enabled on the *single endpoint* responsible for returning user information. We do not recommend enabling these options on all dashboard endpoints. - + + Create an API endpoint that: + - Uses your existing session authentication + - Returns user data in the [UserInfo](./sending-data) format + - Includes proper CORS headers if your API and docs domains differ: + - Set `Access-Control-Allow-Origin` to your docs domain + - Set `Access-Control-Allow-Credentials` to `true` + + + Only enable these CORS settings on your user info endpoint, not across all endpoints. + - - Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication) and add the API URL and your Login URL to your User Auth settings. + + Add your API URL and Login URL in your [Mintlify dashboard settings](https://dashboard.mintlify.com/mintlify/mintlify/settings/deployment/user-authentication). -## Examples - -### Dashboard at subdomain, docs at subdomain - -I have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. My dashboard API routes are hosted at `dash.foo.com/api`. I want to set up authentication for my docs hosted at `docs.foo.com`. - -To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://docs.foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true` **for this route only**. - -I then go to the Mintlify dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field. - -### Dashboard at subdomain, docs at root - -I have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. My dashboard API routes are hosted at `dash.foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`. - -To set up authentication with Mintlify, I create another dashboard endpoint `dash.foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add `https://foo.com` to the `Access-Control-Allow-Origin` allow-list **for this route only**, and ensure my `Access-Control-Allow-Credentials` configuration is set to `true` **for this route only**. - -I then go to the Mintlify dashboard settings and enter `https://dash.foo.com/api/docs/user-info` for the API URL field. - -### Dashboard at root, docs at root +## Example Configurations -I have a dashboard at `foo.com/dashboard`, which uses cookie-based session authentication. My dashboard API routes are hosted at `foo.com/api`. I want to set up authentication for my docs hosted at `foo.com/docs`. +### Different Subdomains +Dashboard: `dash.example.com` +Docs: `docs.example.com` +API Endpoint: `dash.example.com/api/docs/user-info` -To set up authentication with Mintlify, I create another dashboard endpoint `foo.com/api/docs/user-info` which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. +### Root and Subdomain +Dashboard: `dash.example.com` +Docs: `example.com/docs` +API Endpoint: `dash.example.com/api/docs/user-info` -I then go to the Mintlify dashboard settings and enter `https://foo.com/api/docs/user-info` for the API URL field. \ No newline at end of file +### Both at Root +Dashboard: `example.com/dashboard` +Docs: `example.com/docs` +API Endpoint: `example.com/api/docs/user-info` \ No newline at end of file diff --git a/advanced/widget/chat.mdx b/advanced/widget/chat.mdx index 216179a7a..e18788a88 100644 --- a/advanced/widget/chat.mdx +++ b/advanced/widget/chat.mdx @@ -2,19 +2,18 @@ title: "Chat Widget" --- -Integrate the Mintlify widget into your products to offer users quick access to AI-powered chat with your docs content as the knowledge base. +Integrate the Mintlify widget to provide AI-powered chat with your docs content. ![widget](https://mintlify-assets.b-cdn.net/widget/hero.webp) -## Getting started +## Setup -First, generate an API key in [the Mintlify dashboard](https://dashboard.mintlify.com/chat/widget-auth). +1. Get your API key from [the Mintlify dashboard](https://dashboard.mintlify.com/chat/widget-auth) +2. Add the widget to your site: -![widget](https://mintlify-assets.b-cdn.net/widget/key.webp) +### HTML Installation -## Installation - -Add the widget by adding these script tags into your site's `...` tag. +Add to your site's `` tag: ```html ``` -To use the widget in React and Next.js apps, use the React component from the `@mintlify/widget-react` [package](https://www.npmjs.com/package/@mintlify/widget-react). Here is a basic example of how to use the component in your React application: +### React Installation + +Use our React component: ```jsx ``` -## Usage - -In the first script tag or the React component props, you can customize the appearance and other settings of the widget. `mintlifyWidgetSettings` accepts the following props: - -| Prop | Type | Description | -| ------------ | ------------------------------------------------------------------- | ---------------------------------------------------------- | -| `connection` | [MintlifyWidgetConnectionProps](#mintlifywidgetconnectionProps) | Information needed to connect to our API. Required. | -| `display?` | [MintlifyWidgetDisplayProps](#mintlifywidgetdisplayProps) | Configurations for the widget appearance and interactions. | -| `tracking?` | [MintlifyWidgetTrackingFunctions](#mintlifywidgettrackingfunctions) | Callback functions for tracking analytics. | - -### MintlifyWidgetConnectionProps - -| Prop | Type | Description | -| -------- | -------- | ----------------------------------------------------------- | -| `apiKey` | `string` | Widget API key generated from Mintlify dashboard. Required. | -| `url?` | `string` | Used for internal testing only | - -### MintlifyWidgetDisplayProps - -| Prop | Type | Description | -| ------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------- | -| `trigger?` | [MintlifyWidgetDisplayTriggerProps](#mintlifywidgetdisplaytriggerprops) | Appearance of the trigger. | -| `colors?` | [MintlifyWidgetDisplayColorsProps](#mintlifywidgetdisplaycolorsprops) | Colors used across the widget. | -| `chat?` | [MintlifyWidgetDisplayChatProps](#mintlifywidgetdisplaychatprops) | Configs specific to AI chat. | -| `isDarkMode?` | `boolean` | Controlled dark mode appearance. Defaults to OS preference. | - -#### MintlifyWidgetDisplayTriggerProps - -| Prop | Type | Description | -| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | -| `type?` | `'button'`\|`'input'` | Type of the trigger to display. Defaults to `button`. | -| `label?` | `string` | Label displayed in the trigger. Defaults to `Get help` for the button trigger and `Ask anything...` for the input trigger. | -| `buttonIcon?` | `'chat'`\|`'sparkles'`\|`'mintlify'` | Icon used in the trigger. Only available for the `button` trigger. Defaults to `chat`. | -| `iconOnly?` | `boolean` | Only show icon in the trigger or not. Defaults to `false`. | - -Here is an overview of what the trigger looks like with different configurations. - -| `type='input'` | | -| -------------- | ------------------------------------------------------------ | -| | | - -| `type='button'` | `'chat'` | `'sparkles'` | `'mintlify'` | -| ---------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `iconOnly=false` | | | | -| `iconOnly=true` | | | | - -#### MintlifyWidgetDisplayColorsProps - -| Prop | Type | Description | -| --------------- | -------- | -------------------------------------------------------- | -| `primary?` | `string` | Primary color used in the widget. Defaults to `#0D9373`. | -| `primaryLight?` | `string` | Primary color in dark mode. Defaults to `#55D799`. | - -#### MintlifyWidgetDisplayChatProps +## Configuration -| Prop | Type | Description | -| ------------------------ | ---------- | ------------------------------------------------------------------ | -| `openCitationInSameTab?` | `boolean` | Open the citation url in the same tab or not. Defaults to `false`. | -| `exampleQueries?` | `string[]` | Example queries to prompt the user to ask. Defaults to `[]`. | +The widget accepts these main configuration options: -### MintlifyWidgetTrackingFunctions +| Prop | Description | +| ------------ | ---------------------------------------------------------- | +| `connection` | API connection settings (required) | +| `display` | Widget appearance and interaction settings | +| `tracking` | Analytics callback functions | -| Prop | Type | Description | -| --------------------- | ------------------------------------------ | -------------------------------------------------- | -| `trackChatEnter` | `()=> void` | Triggered when the user opens the chat widget. | -| `trackCitationClick` | `(title: string, url: string)=> void` | Triggered when the user clicks on a citation. | -| `trackChatThumbsUp` | `(query: string, response: string)=> void` | Triggered when the user thumbs up on a response. | -| `trackChatThumbsDown` | `(query: string, response: string)=> void` | Triggered when the user thumbs down on a response. | -| `trackChatFollowup` | `(query: string)=> void` | Triggered when the user asks a question. | -| `trackChatClose` | `(queriesCount: number)=> void` | Triggered when the user exits the chat widget. | +For detailed configuration options, visit our [configuration guide](/path-to-detailed-config). \ No newline at end of file diff --git a/api-playground/mdx/configuration.mdx b/api-playground/mdx/configuration.mdx index 55682df30..599246c0e 100644 --- a/api-playground/mdx/configuration.mdx +++ b/api-playground/mdx/configuration.mdx @@ -3,25 +3,24 @@ title: 'MDX Setup' description: 'Generate docs pages for your API endpoints using MDX' --- -Mintlify allows you to define your API endpoints using a combination of `mint.json` configuration, MDX metadata fields, and the `` component. From the defined endpoints, we generate an API playground, request examples, and response examples. +Mintlify generates an API playground, request examples, and response examples from your endpoint definitions. Here's how to set it up: - In your `mint.json` file, define your base URL and auth method: + Add your API configuration to `mint.json`: ```json { "api": { - "baseUrl": "https://mintlify.com/api", // string array for multiple base URLs + "baseUrl": "https://mintlify.com/api", "auth": { - "method": "bearer" // options: bearer, basic, key. + "method": "bearer" } } } ``` - If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field: - + To hide the API playground, use: ```json { "api": { @@ -31,35 +30,25 @@ Mintlify allows you to define your API endpoints using a combination of `mint.js } } ``` - - Find a full list of API configurations [here](/settings/global#api-configurations). - - - Each API endpoint page should have a corresponding MDX file. At the top of each file, define: + + Create an MDX file for each endpoint with the required metadata: ```md --- title: 'Create new user' - api: 'POST https://api.mintlify.com/user' + api: 'POST /user' --- ``` - You can specify path parameters by adding the parameter name to the path, wrapped with `{}`: - + For paths with parameters, use `{}`: ```bash - https://api.example.com/v1/endpoint/{userId} + /v1/endpoint/{userId} ``` - - - - If you have `baseUrl` configured in [mint.json](/settings/global), you can use relative paths like `/v1/endpoint`. - - - - Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `mint.json`. Learn more about structuring your docs [here](/settings/navigation). + + Include your endpoint pages in the `navigation` field of `mint.json`. - + \ No newline at end of file diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index 7d45da4f6..7adfc36dc 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -5,145 +5,57 @@ description: "Reference OpenAPI endpoints in your docs pages" ## Add an OpenAPI specification file -To describe your endpoints with OpenAPI, make sure you have a valid OpenAPI -document in either JSON or YAML format that follows the -[OpenAPI specification](https://swagger.io/specification/). Your document must -follow OpenAPI specification 3.0+. +Add a valid OpenAPI document (version 3.0+) in either JSON or YAML format to your project. -## Auto-populate API pages +## Configure API Documentation -The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor. +There are two ways to document your API endpoints: -**Example with Anchors:** +### 1. Auto-generate API pages -```json {5} +Add an `openapi` field to your `mint.json` configuration: + +```json { "anchors": [ { "name": "API Reference", "openapi": "/path/to/openapi.json", - "url": "api-reference", - "icon": "square-terminal" - } - ] -} -``` - -![](/images/anchors-autogeneration-anchors.png) - -**Example with Tabs:** - -```json {6} -{ - "tabs": [ - { - "name": "API Reference", - "url": "api-reference", - "openapi": "https://petstore3.swagger.io/api/v3/openapi.json" + "url": "api-reference" } ] } ``` -![](/images/autogeneration-with-tabs.png) - -When using this option, the metadata for the generated pages will have the following default values: - -* `title`: The `summary` field from the OpenAPI operation, if present. Otherwise a title generated from the HTTP method and endpoint. - -* `description`: The `description` field from the OpenAPI operation, if present. - -* `version`: The `version` value from the anchor or tab, if present. - -There are some scenarios in which the default behavior isn't sufficient. If you need more customizability, you can create an MDX page for your OpenAPI operation, and modify it just like any other MDX page. - -## Create MDX files for API pages - -If you want to customize the page metadata, add additional content, omit certain OpenAPI operations, or reorder OpenAPI pages in your navigation, you'll need an MDX page for each operation. Here is [an example MDX OpenAPI page](https://github.com/elevenlabs/elevenlabs-docs/blob/e5e267c97b8d1e4c21db1dcdb8b005eb1dfed7da/api-reference/speech-to-speech.mdx?plain=1#L2) from [Elevenlabs](https://elevenlabs.io/docs/api-reference/speech-to-speech). - -![](/images/elevenlabs-mdx-autogeneration-example.png) - -### Autogenerate files - -For large OpenAPI documents, creating one MDX page for each OpenAPI operation can be a lot of work. To make it easier, we created a local OpenAPI page scraper. +This automatically generates pages for each API operation with default metadata from your OpenAPI specification. -Our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) -autogenerates MDX files for your OpenAPI endpoints. Use the relative path to the -OpenAPI document in your codebase. +### 2. Create Custom MDX Files -```bash -npx @mintlify/scraping@latest openapi-file -``` - -Add the `-o` flag to specify a folder to populate the files into. If a folder is -not specified, the files will populate in the working directory. +For more customization, create individual MDX files for each endpoint. You can: +- Use our scraper to auto-generate MDX files: ```bash npx @mintlify/scraping@latest openapi-file -o api-reference ``` -Learn more about our scraping package [here](https://www.npmjs.com/package/@mintlify/scraping). - -The scraper will output an array of -[Navigation entries](/settings/global#structure) containing your OpenAPI MDX -files. You can either append these entries to your existing Navigation, or -reorder and add the files to your navigation manually. - - - If your OpenAPI document is invalid, the files will not autogenerate. - - -### Manually specify files - -You can always create an MDX page manually, and reference the OpenAPI operation in the page's metadata using the `openapi` field. - - - -By using the OpenAPI reference, the name, description, parameters, responses, -and the API playground will be automatically generated from the OpenAPI document. - -If you have multiple OpenAPI files, include the path to the OpenAPI file to ensure Mintlify finds the correct OpenAPI document. This is not required if you have -only one OpenAPI file - it will automatically detect your OpenAPI file. - - - ```md Example - --- - title: "Get users" - openapi: "/path/to/openapi-1.json GET /users" - --- - ``` - - ```md Format - --- - title: "title of the page" - openapi: openapi-file-path method path - --- - ``` - - -
+- Or manually create MDX files: +```md +--- +title: "Get users" +openapi: "GET /users" # Format: method path +--- +``` - The method and path must match the method and path specified in the OpenAPI - document exactly. If the endpoint doesn't exist in the OpenAPI file, - the page will be empty. + For multiple OpenAPI files, specify the file path: `openapi: "/path/to/openapi.json GET /users"` -## Create MDX files for OpenAPI schemas - -Mintlify also allows you to create individual pages for any OpenAPI schema -defined in an OpenAPI document's `components.schemas` field: +### OpenAPI Schemas - - ```md Example - --- - openapi-schema: OrderItem - --- - ``` +To document specific schemas, create an MDX file with: - ```md Format - --- - openapi-schema: "schema-key" - --- - ``` - \ No newline at end of file +```md +--- +openapi-schema: "SchemaName" +--- +``` \ No newline at end of file diff --git a/content/components/accordion-groups.mdx b/content/components/accordion-groups.mdx index 29f90169c..22fdd374f 100644 --- a/content/components/accordion-groups.mdx +++ b/content/components/accordion-groups.mdx @@ -4,58 +4,38 @@ description: "Group multiple accordions into a single display." icon: "table-rows" --- -Simply add `` around your existing `` components. +Wrap multiple `` components with `` to group them together. - - You can put other components inside Accordions. - - ```java HelloWorld.java - class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } - } - ``` - + + You can put any content inside Accordions. - - Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + Add icons using the `icon` prop. - - Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + See the [Accordion](/content/components/accordions) docs for all available props. - -````jsx Accordion Group Example +```jsx - - You can put other components inside Accordions. - - ```java HelloWorld.java - class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } - } - ``` - + + You can put any content inside Accordions. - - Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + Add icons using the `icon` prop. - - Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + See the Accordion docs for all available props. -```` - +``` -`AccordionGroup` does not have any props. +Note: `AccordionGroup` does not accept any props. \ No newline at end of file diff --git a/development.mdx b/development.mdx index 15581014c..5aac3364a 100644 --- a/development.mdx +++ b/development.mdx @@ -4,99 +4,53 @@ description: 'Preview changes locally to update your docs' --- - -**Prerequisite**: Please install Node.js (version 19 or higher) before proceeding. - +**Prerequisite**: Node.js (version 19 or higher) -**Step 1**: Install Mintlify: - - +## Setup and Preview - ```bash npm - npm i -g mintlify - ``` - -```bash yarn -yarn global add mintlify +1. Install Mintlify CLI: +```bash +npm i -g mintlify ``` - - -**Step 2**: Navigate to the docs directory (where the `mint.json` file is located) and execute the following command: - +2. Run the development server: ```bash mintlify dev ``` -A local preview of your documentation will be available at `http://localhost:3000`. +Your docs will be available at `http://localhost:3000`. -### Custom Ports +## Common Tasks -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: +### Using a Different Port ```bash -mintlify dev --port 3333 +mintlify dev --port ``` -If you attempt to run Mintlify on a port that's already in use, it will use the next available port: - -```md -Port 3000 is already in use. Trying 3001 instead. -``` - -## Mintlify Versions - -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: +### Update Mintlify CLI - - - ```bash npm - npm i -g mintlify@latest - ``` - -```bash yarn -yarn global upgrade mintlify +```bash +npm i -g mintlify@latest ``` - - -## Validating Links - -The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: +### Check for Broken Links ```bash mintlify broken-links ``` -## Deployment - -If the deployment is successful, you should see the following: - - - - - -## Code Formatting - -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. - ## Troubleshooting - - - 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` + + 1. Remove mintlify: `npm remove -g mintlify` + 2. Upgrade to Node v19+ + 3. Reinstall: `npm install -g mintlify` - - - Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. + + Delete ~/.mintlify folder and run `mintlify dev` again. - + \ No newline at end of file diff --git a/integrations/analytics/google-analytics.mdx b/integrations/analytics/google-analytics.mdx index 7ebfe1610..7164e28db 100644 --- a/integrations/analytics/google-analytics.mdx +++ b/integrations/analytics/google-analytics.mdx @@ -2,27 +2,20 @@ title: "Google Analytics 4" --- -You will need to generate a new GA4 property to use with Mintlify. The data collected will go into the same project as your other Google Analytics data. +GA4 allows you to track visitor analytics for your documentation. Here's how to set it up with Mintlify: -If you are using the old version of Google Analytics, Universal Analytics, you will still be able to generate a GA4 property. GA4 data is slightly different from UA data but still gets collected in the same project. +## Setup Steps -## How to Connect GA4 to Mintlify - -### Create a Web Stream - -You will need to create a web stream to get the Measurement ID to put into Mintlify. - -Click the cog at the bottom left of the Google Analytics screen. Then click on Data Streams. +1. Create a GA4 property in your Google Analytics account +2. Create a web stream + - Go to Settings (cog icon) → Data Streams + - Click "Add Stream" → "Web" + - Enter your Mintlify docs URL + - Copy your Measurement ID (format: `G-XXXXXXX`) ![](/images/ga4-web-streams.png) -Create a Web Stream and put the URL of your Mintlify docs site as the stream URL. - -Your Measurement ID looks like `G-XXXXXXX` and will show up under Stream Details immediately after you create the Web Stream. - -### Put Measurement ID in mint.json - -Add your Measurement ID to your `mint.json` file like so: +3. Add the Measurement ID to your `mint.json`: ```json mint.json "analytics": { @@ -32,14 +25,9 @@ Add your Measurement ID to your `mint.json` file like so: } ``` -### Wait - -Google Analytics takes two to three days to show your data. - -You can use the [Google Analytics Debugger](https://chrome.google.com/webstore/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna?hl=en) to check analytics are enabled correctly. The extension will log to your browser's console every time GA4 makes a request. - - - -Preview links have analytics turned off. +## Important Notes - +- Data takes 2-3 days to appear in Google Analytics +- Preview links do not track analytics +- You can use the [Google Analytics Debugger](https://chrome.google.com/webstore/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna?hl=en) to verify setup + \ No newline at end of file diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index dff95d35a..1dd71efc5 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -33,43 +33,6 @@ description: "Integrate with an analytics platform to track viewer events" } > - - - - - - - - } -> - - - - - - - - - - - } -> - } > - - - - - -} - -> - - - - - - - } -> - - - - - - - - - - - - - - - - - - - - - - - - - - - } -> - - - - - - - - - - - - - - - - - - - - - - - - - - - } -> - - - - - - - -}> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - } -> - - - - - - } -> - - - - - - - - - } -/> - -## Enabling Analytics - -Set your analytics keys in `mint.json`. You can add an unlimited number of analytics integrations for free. - -The syntax for `mint.json` is below. You only need to include entries for the platforms you want to connect. - - - -```json Analytics options in mint.json -"analytics": { - "amplitude": { - "apiKey": "required" - }, - "clearbit": { - "publicApiKey": "required" - }, - "fathom": { - "siteId": "required" - }, - "ga4": { - "measurementId": "required" - }, - "gtm": { - "tagId": "required" - }, - "hotjar": { - "hjid": "required", - "hjsv": "required" - }, - "koala": { - "publicApiKey": "required" - }, - "logrocket": { - "appId": "required" - }, - "mixpanel": { - "projectToken": "required" - }, - "pirsch": { - "id": "required" - }, - "plausible": { - "domain": "required" - }, - "posthog": { - "apiKey": "required", - "apiHost": "optional" - }, -} -``` - -```json Google Analytics 4 Example -"analytics": { - "ga4": { - "measurementId": "G-XXXXXXX" +## Configuration + +Enable analytics by adding your keys to `mint.json`: + +```json +{ + "analytics": { + "amplitude": { + "apiKey": "..." + }, + "ga4": { + "measurementId": "G-XXXXXXX" + }, + "hotjar": { + "hjid": "...", + "hjsv": "..." + }, + "mixpanel": { + "projectToken": "..." + } } } ``` - \ No newline at end of file +You can enable multiple analytics platforms simultaneously. See individual integration pages for setup details. \ No newline at end of file diff --git a/integrations/analytics/plausible.mdx b/integrations/analytics/plausible.mdx index 4d478842c..b33e9e42d 100644 --- a/integrations/analytics/plausible.mdx +++ b/integrations/analytics/plausible.mdx @@ -2,24 +2,11 @@ title: "Plausible" --- -Add your site's domain to `mint.json` to send analytics to Plausible. - - - - Do not include `http://` or `https://` with your domain. - +To enable Plausible analytics, add your site's domain (without `http://` or `https://`) to `mint.json`: -```json Analytics options in mint.json -"analytics": { - "plausible": { - "domain": "required" - } -} -``` - -```json Example +```json mint.json "analytics": { "plausible": { "domain": "docs.domain.com" @@ -28,3 +15,4 @@ Add your site's domain to `mint.json` to send analytics to Plausible. ``` + \ No newline at end of file diff --git a/integrations/analytics/posthog.mdx b/integrations/analytics/posthog.mdx index b78cabb18..db03f67d5 100644 --- a/integrations/analytics/posthog.mdx +++ b/integrations/analytics/posthog.mdx @@ -2,17 +2,15 @@ title: "PostHog" --- -Add the following to your `mint.json` file to send analytics to PostHog. - -You only need to include `apiHost` if you are self-hosting PostHog. We send events to `https://app.posthog.com` by default. +Configure PostHog analytics by adding the following to your `mint.json`: -```json Analytics options in mint.json +```json mint.json "analytics": { "posthog": { "apiKey": "required", - "apiHost": "optional" + "apiHost": "optional" // Only needed for self-hosted PostHog } } ``` @@ -27,12 +25,10 @@ You only need to include `apiHost` if you are self-hosting PostHog. We send even -
- Enabling PostHog analytics will disable the analytics on the Mintlify dashboard. ## Session Recordings -You need to add the URL for your docs website to Posthog's "Authorized domains for recordings" before you can receive session recordings. The option to add your URL is in Posthog's project settings. +To enable session recordings, add your docs website URL to PostHog's "Authorized domains for recordings" in your project settings. \ No newline at end of file diff --git a/integrations/privacy/osano.mdx b/integrations/privacy/osano.mdx index ded3d2d59..637ed32ec 100644 --- a/integrations/privacy/osano.mdx +++ b/integrations/privacy/osano.mdx @@ -2,26 +2,16 @@ title: "Osano" --- -Add the following to your `mint.json` file to add the [Osano](https://www.osano.com/) cookie consent manager. +To add the [Osano](https://www.osano.com/) cookie consent manager, include the following in your `mint.json`: -```json Integration options in mint.json +```json mint.json "integrations": { "osano": "SOURCE" } ``` -```json Example -"integrations": { - "osano": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js" -} -``` - -The `SOURCE` can be found as the `src` value in the code snippet generated by Osano. It always starts with `https://cmp.osano.com/`. - -```html Code snippet from Osano -