From 7094ecb8a6a06f85e64b791eaf77cd3c66cf8271 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 21 Jan 2025 18:36:05 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- list-table.mdx | 21 ++-- mint.json | 21 ++-- .../authentication-vs-personalization.mdx | 40 +++---- .../choosing-a-handshake.mdx | 10 +- text.mdx | 102 +++++++----------- 5 files changed, 81 insertions(+), 113 deletions(-) diff --git a/list-table.mdx b/list-table.mdx index bbaef913c..89a775688 100644 --- a/list-table.mdx +++ b/list-table.mdx @@ -62,27 +62,24 @@ Lists follow the official [markdown syntax](https://www.markdownguide.org/basic- ## Tables +Tables use pipes (`|`) to separate columns and hyphens (`-`) to create headers. For compatibility, add pipes on both ends of each row. + | Property | Description | | -------- | ------------------------------------- | | Name | Full name of user | | Age | Reported age | | Joined | Whether the user joined the community | - -### Creating a table - - - -The Table component follows the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables). - - - -To add a table, use three or more hyphens (`---`) to create each column's header, and use pipes (`|`) to separate each column. For compatibility, you should also add a pipe on either end of the row. - ```md | Property | Description | | -------- | ------------------------------------- | | Name | Full name of user | | Age | Reported age | | Joined | Whether the user joined the community | -``` \ No newline at end of file +``` + + + +Tables follow the official [markdown syntax](https://www.markdownguide.org/extended-syntax/#tables). + + \ No newline at end of file diff --git a/mint.json b/mint.json index 3c1bef202..f856d07f4 100644 --- a/mint.json +++ b/mint.json @@ -65,12 +65,14 @@ "icon": "pen-paintbrush", "pages": [ "development", - "web-editor" + "web-editor", + "text" ] }, "settings/global", "settings/navigation", - "migration" + "migration", + "list-table" ] }, { @@ -164,10 +166,12 @@ "settings/authentication-personalization/personalization-setup/choosing-a-handshake", "settings/authentication-personalization/personalization-setup/shared-session", "settings/authentication-personalization/personalization-setup/jwt", - "settings/authentication-personalization/personalization-setup/oauth" + "settings/authentication-personalization/personalization-setup/oauth", + "settings/authentication-personalization/personalization-setup/choosing-a-handshake" ] }, - "settings/authentication-personalization/sending-data" + "settings/authentication-personalization/sending-data", + "settings/authentication-personalization/authentication-vs-personalization" ] }, { @@ -192,11 +196,10 @@ { "group": "Chat API", "pages": [ - "advanced/rest-api/chat/create-topic", - "advanced/rest-api/chat/generate-message" - ] - } - + "advanced/rest-api/chat/create-topic", + "advanced/rest-api/chat/generate-message" + ] + } ] } ] diff --git a/settings/authentication-personalization/authentication-vs-personalization.mdx b/settings/authentication-personalization/authentication-vs-personalization.mdx index c6be06046..43f8913c6 100644 --- a/settings/authentication-personalization/authentication-vs-personalization.mdx +++ b/settings/authentication-personalization/authentication-vs-personalization.mdx @@ -3,35 +3,27 @@ title: 'Auth vs Personalization' description: 'How to determine which product is best for you' --- -Mintlify offers both Authentication and Personalization. For the most part, Authentication is -just Personalization + privacy. However, there are some key differences that are important to -be aware of, from most important to least: +While Mintlify offers both Authentication and Personalization products, understanding their key differences will help you choose the right solution for your needs: ### Security Guarantees -Authentication is a fully-fledged private documentation solution. Every aspect of your docs, -including page content, images, search results, and AI chat features, are completely inaccessible to -unauthenticated users. +Authentication provides complete privacy for your documentation: +- All page content and assets are inaccessible to unauthenticated users +- Search results and AI chat features require authentication +- Preview deployments can be restricted to authenticated users only -Personalization, on the other hand, offers no security guarantees for your documentation content. -All page content, images, search results, and AI chat features can be accessed by the public. Even -if you are using the hidden pages feature of Personalization, a motivated attacker would still -be able to access the content of a hidden page. +Personalization has no security restrictions: +- All content remains publicly accessible +- Hidden pages can still be accessed directly +- Best for customizing public documentation based on user attributes -### Handshake Methods +### Available Handshake Methods -Due to the difference in security requirements for Authentication and Personalization, different -handshake methods are available for each. Both methods offer a JWT and OAuth Handshake, although -the setup steps are slightly different. +Both Authentication and Personalization support JWT and OAuth handshakes, with some method differences: -Authentication offers two additional Handshake methods: +Authentication offers: +- Password Handshake: Protect docs with a configurable global password +- Mintlify Auth Handshake: Limit access to Mintlify dashboard users only -- **Password Handshake**, which protects your website with a single configurable global password. - -- **Mintlify Auth Handshake**, which will allow users to view your documentation only if they have -access to your dashboard. - -Personalization offers one additional Handshake method: - -- **Shared Session Handshake**, a super simple method which only requires setting up a single endpoint -that returns data for already-authenticated users. +Personalization offers: +- Shared Session Handshake: Reuse your existing user sessions with a single endpoint \ No newline at end of file diff --git a/settings/authentication-personalization/personalization-setup/choosing-a-handshake.mdx b/settings/authentication-personalization/personalization-setup/choosing-a-handshake.mdx index 9c7823cc3..1b7cb5e68 100644 --- a/settings/authentication-personalization/personalization-setup/choosing-a-handshake.mdx +++ b/settings/authentication-personalization/personalization-setup/choosing-a-handshake.mdx @@ -7,11 +7,11 @@ description: 'How to decide which Handshake method is right for your docs' This is the documentation for **Personalization** Handshake methods. Authentication offers a [different set of Handshake methods](/settings/authentication-personalization/authentication-setup/choosing-a-handshake). -Before your users can access personalized content, they must be authenticated. Mintlify supports three Personalization Handshake methods: +Mintlify supports three Personalization Handshake methods to authenticate users and access personalized content: -1. **Shared Session**: Utilize the same session token used by your dashboard to authenticate users. -2. **JWT**: Use your own login flow to send user info to your docs via a JWT in the URL. -3. **OAuth 2.0**: Integrate with your OAuth server to enable user login via the PKCE flow. +- **Shared Session**: Utilize your existing dashboard session token +- **JWT**: Use your own login flow with JWT authentication +- **OAuth 2.0**: Integrate with your OAuth server using PKCE flow ## Prerequisites @@ -82,4 +82,4 @@ Before your users can access personalized content, they must be authenticated. M - Dashboard sessions and docs authentication are completely decoupled, so users will need to log in to your dashboard and your docs separately - Might be overkill for some applications - + \ No newline at end of file diff --git a/text.mdx b/text.mdx index 45cec9193..897f4b08b 100644 --- a/text.mdx +++ b/text.mdx @@ -4,103 +4,79 @@ description: "Text, title, and styling in standard markdown" icon: 'heading' --- -## Titles +## Titles and Headers -Best used for section headers. +Add `##` or `###` at the start of a line to create headers of different levels: ```md -## Titles -``` - -### Subtitles - -Best used for subsection headers. - -```md -### Subtitles +## Title (H2) +### Subtitle (H3) ``` - -Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. - +Each header creates an anchor and appears in the table of contents on the right. ## Text Formatting -We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. +Format text using the following markdown syntax: -| Style | How to write it | Result | -| ------------- | ----------------- | --------------- | -| Bold | `**bold**` | **bold** | -| Italic | `_italic_` | _italic_ | +| Style | Syntax | 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 can combine styles by nesting them: `**_bold and italic_**` → **_bold and italic_** -You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text. +For super/subscript text, use HTML tags: -| Text Size | How to write it | Result | -| ----------- | ------------------------ | ---------------------- | -| Superscript | `superscript` | superscript | -| Subscript | `subscript` | subscript | +| Text Position | Syntax | Result | +| --- | --- | --- | +| Superscript | `text` | text | +| Subscript | `text` | text | -## Linking to Pages +## Links -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). +Create links using `[text](url)` syntax: +- External links: `[Google](https://google.com)` +- Internal docs links: Use root-relative paths like `/folder/page` + - Example: `[Text components](/content/text)` + - Avoid relative paths like `../text` for better performance -Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/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. - -You can validate broken links in your docs with [our CLI](/development). + +Use our CLI ([see Development docs](/development)) to check for broken links. + ## 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. +Create blockquotes by adding `>` before text: -```md -> Dorothy followed her through many of the beautiful rooms in her castle. -``` +> Single-line blockquote example -### Multiline +Multiple paragraphs require `>` followed by a blank line: -> Dorothy followed her through many of the beautiful rooms in her castle. +> First paragraph of the quote > -> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. +> Second paragraph of the quote -```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 +## Math Formatting with LaTeX -Mintlify supports in-line [LaTeX](https://www.latex-project.org) by surrounding your LaTeX code with dollar signs (\$). For example, `$(a^2 + b^2 = c^2)$` will render as $(a^2 + b^2 = c^2)$. +Add inline math formulas by wrapping LaTeX in single `$`: +- Example: `$(a^2 + b^2 = c^2)$` → $(a^2 + b^2 = c^2)$ -Equations on their own line can be created with double dollar signs (\$\$): +For display math formulas, use double `$$`: $$\exists \, x \notin [0,1]$$ -```md -$$\exists \, x \notin [0,1]$$ -``` - -### Line Breaks +## Line Breaks -Markdown syntax also recognizes a double enter in your MDX as a linebreak. - -```html -
-``` +Create line breaks either with: +- HTML tag: `
` +- Two line breaks in markdown: ```md Paragraph 1 Paragraph 2 -``` +``` \ No newline at end of file