From 68f4bb55b590eb02581e8434a8240fe43543b8bc Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Fri, 26 Jul 2024 18:17:58 -0700 Subject: [PATCH 1/2] Add broken links CI --- .github/workflows/check-links.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/check-links.yml diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 000000000..f9c2fc1a7 --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,18 @@ +name: Check links + +on: pull_request + +jobs: + check-links: + name: Check links + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Node + uses: actions/setup-node@v4 + with: + node-version: "latest" + - name: Install Mintlify CLI + run: npm i -g mintlify + - name: Run broken link checker + run: mintlify broken-links From 11713cec2467129edb39396df1f3a182d79b69cf Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Thu, 22 Aug 2024 10:21:23 -0700 Subject: [PATCH 2/2] fix all broken links --- component-library.mdx | 86 ------------------------------- content/components/accordions.mdx | 19 +++---- embed.mdx | 58 --------------------- quickstart.mdx | 20 ++++--- 4 files changed, 24 insertions(+), 159 deletions(-) delete mode 100644 component-library.mdx delete mode 100644 embed.mdx diff --git a/component-library.mdx b/component-library.mdx deleted file mode 100644 index c7ff82037..000000000 --- a/component-library.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: 'Components' -description: 'Enhance your docs with our pre-built components ' ---- - -Mintlify provides a library of built-in components to make your docs beautiful without formatting things yourself. They can be added **directly within your files**. Some components are rendered from [Markdown syntax](https://www.markdownguide.org/basic-syntax/), while other components work the same way as [React components](https://reactjs.org/docs/components-and-props.html). - - - Customize the style of components with [Tailwind - CSS](https://tailwindcss.com/). Simply add `className="tailwind styles"` onto - the component. - - -## Examples - -### Code Blocks - -The following example is a [Code](/content/code) component, which lets you display syntax-highlighted code. - -```java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - -It's rendered using the following code. - -````md -```java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` -```` - -### Callouts - -To present additional context outside of the main content, you can use a [Callout](/content/components/callouts) component. Find Warnings and Notes in addition to Tip callouts here. - -This suggests a helpful tip - -```md -This suggests a helpful tip -``` - -### Accordions - -Use the [Accordian](/content/components/accordion) component to create a dropdown with additional content. - - - You can put any content in here. - - -```md - - You can put any content in here. - -``` - -### Cards - -To highlight important points and links, you can use a [Card](/content/components/cards) component. - - - This is how you use a card with an icon and a link. Clicking on this card - brings you to the Card components page. - - -```md - - This is how you use a card with an icon and a link. Clicking on this card - brings you to the Card components page. - -``` - -### Other - -For a full list of pre-built components, see our [Components library](/content/components). You can also contribute to our components in our [repository](https://github.com/mintlify/components). - -### Requests - -If there are any components that you would like to have but aren't currently available, contact our team at [support@mintlify.com](mailto:support@mintlify.com). diff --git a/content/components/accordions.mdx b/content/components/accordions.mdx index 626687d7f..a48159b29 100644 --- a/content/components/accordions.mdx +++ b/content/components/accordions.mdx @@ -1,22 +1,23 @@ --- -title: 'Accordions' -description: 'A dropdown component for toggling content' -icon: 'square-caret-down' +title: "Accordions" +description: "A dropdown component for toggling content" +icon: "square-caret-down" --- You can put any content in here. Check out - [AccordionGroup](/content/components/accordion-group) if you want to group + [AccordionGroup](/content/components/accordion-groups) if you want to group multiple Accordions into a single display. - ```jsx Accordion Example - - You can put any content in here. - - ``` +```jsx Accordion Example + + You can put any content in here. + +``` + ## Props diff --git a/embed.mdx b/embed.mdx deleted file mode 100644 index 3edd081a8..000000000 --- a/embed.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Custom Embeds" -description: "Images, videos, and any HTML elements" ---- - - - -
- - - -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. - - - -Here are some common HTML tags that are used for documentation - -## Embed - -### iFrames - -Loads another HTML page within the document. Most commonly used for embedding videos. - -```html - -``` - -To have videos autoplay, add `autoplay = {true}`. - - - Additionally, we support mp4 files up to 5 MB and you can also upload your - videos to storage services like Cloudinary to reference them in your Mintlify - documentation! - - -### Images - -Insert an image onto the page. Used over the standard [markdown image syntax](/content/image-embeds#using-markdown) for more control over the image styling. - -```html - -``` - -### Line Breaks - -Add a linebreak - -```html -
-``` diff --git a/quickstart.mdx b/quickstart.mdx index fd25eb27d..cc5f24507 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -15,11 +15,14 @@ icon: "rocket" ## Getting Started -Welcome to the Mintlify documentation guide. Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify. +Welcome to the Mintlify documentation guide. Follow the instructions below to +learn how to deploy, update and supercharge your documentation with Mintlify. ### 1. Deploying Your Docs Repository -Mintlify docs are rendered from MDX files and configurations defined in our [starter template](https://github.com/mintlify/starter). We use Github to integrate your docs with your code, and make source control effortless. +Mintlify docs are rendered from MDX files and configurations defined in our +[starter template](https://github.com/mintlify/starter). We use Github to +integrate your docs with your code, and make source control effortless. @@ -46,7 +49,8 @@ Mintlify docs are rendered from MDX files and configurations defined in our [sta ### 2. Updating Your Docs -Mintlify enables you to easily customize the style, structure, and content of your docs. +Mintlify enables you to easily customize the style, structure, and content of +your docs. We provide a white-glove migration service as part of our startup plan. @@ -108,7 +112,7 @@ Mintlify enables you to easily customize the style, structure, and content of yo --- ``` - Learn more about adding images, tables, lists, and more using the [MDX syntax](/content/text). We also offer a wide array of components which are listed [here](/content/components). + Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a wide array of components which are listed [here](/content/components). @@ -123,7 +127,8 @@ Mintlify enables you to easily customize the style, structure, and content of yo ### 3. Supercharging Your Docs -Mintlify supports an array of advanced features like API reference docs, analytics, and versioning to accommodate any of your documentation needs. +Mintlify supports an array of advanced features like API reference docs, +analytics, and versioning to accommodate any of your documentation needs. @@ -165,4 +170,7 @@ Mintlify supports an array of advanced features like API reference docs, analyti ### All Done! -Congrats! You've set up your Mintlify Docs and it's looking amazing! Need support or want to give some feedback? You can join our [community](https://mintlify.com/community) or drop us an email at [support@mintlify.com](mailto:support@mintlify.com). +Congrats! You've set up your Mintlify Docs and it's looking amazing! Need +support or want to give some feedback? You can join our +[community](https://mintlify.com/community) or drop us an email at +[support@mintlify.com](mailto:support@mintlify.com).