diff --git a/changelog/2024-09.mdx b/changelog/2024-09.mdx index d4158ba55..5e914a0f8 100644 --- a/changelog/2024-09.mdx +++ b/changelog/2024-09.mdx @@ -1,10 +1,15 @@ --- title: "September 2024" -description: "Speed improvements and JWT Auth" +description: "Custom fonts, images in cards, and more" --- -Last updated on: **2024-09-15** +## Google Fonts +You can now use any Google Font or add a custom font to your docs. + +## [Images in Card components](/content/components/cards#image-card) + +Add an `img` property to a card to display an image on the top of the card. ## Update Speed Performances For large projects (~3,000 files), the download step for docs updates is now @@ -16,8 +21,22 @@ updates are now ~5.5x faster - an 81.8% time reduction. The navbar hierarchy follows the aria hierarchy. We also added an aria label to the light/dark mode toggle. +## Dashboard Improvements + +- App router migration in the dashboard. +- Search analytics are now available in the dashboard. +- Delete an org functionality has been added to the dashboard. +- Shipped GitLab connection UI. +- Fix incorrect analytics data. +- Add-on's can now be directly purchased through the dashboard. + +## Bug Fixes + +- Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`. +- Fix relative positioning of the AI widget. + ## More - **Troubleshooting for API pages**: API pages could be complicated so we listed common issues to help you sort them out quickly — - [Read the docs](/api-playground/troubleshooting) + [Read the docs](/api-playground/troubleshooting) \ No newline at end of file diff --git a/changelog/2024-10.mdx b/changelog/2024-10.mdx new file mode 100644 index 000000000..694767436 --- /dev/null +++ b/changelog/2024-10.mdx @@ -0,0 +1,90 @@ +--- +title: "October 2024" +description: "New landing page, advanced footer, and more" +--- + +Last updated on: **2024-10-23** + +## [Code Line Highlighting](/content/components/code#line-highlighting) + +You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas. + +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` + +````md +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` +```` + +## Light mode code blocks + +Code blocks now have a light mode variant which can be enabled by adding the following to your `mint.json`: + +```json +"code": { + "mode": "auto" +} +``` + +## Advanced Footer + +Advanced Footer + +You can now add more links to the standard footer. This upgrade +provides more consistency between landing pages and docs, or greater customization +if you want to spotlight specific pages like socials or status logs. + +## New Landing Page + +Landing Page + +1. Showcasing vision for the future + +It's been a year since we've last updated our landing page, and our team has shipped A LOT. + +As we grow, we will no longer be just a documentation platform, but the platform for technical content, encompassing much more than just docs. + +2. Feature our new customers + +We've gotten to work with many incredible companies, and wanted to give them a shoutout. + +3. Increase iteration velocity + +Instead of building a standalone app, we built it in Webflow. This way, our entire team can contribute and experiment with the landing page. + +## Filter search based on the current user + +When user auth is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content. + +## Custom Prompts for AI Chat + +You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts. + +## Dashboard Improvements + +- Consolidated the login and signup pages to decrease friction and confusion. +- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. + +## Bug Fixes + +- Fixed `suggestEdit` not showing up even when enabled. +- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results. +- Don't allow search engines to crawl user-auth protected pages. +- Revalidate the cache when an org is deleted. +- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages. +- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions. +- Add in-line-style support for icons +- Fixed the pop-in of custom CSS in docs. +- Properly show in-line code styling in conjunction with links. +- Maintain scroll position when you click the back button in a browser. \ No newline at end of file diff --git a/changelog/overview.mdx b/changelog/overview.mdx new file mode 100644 index 000000000..37d99a47d --- /dev/null +++ b/changelog/overview.mdx @@ -0,0 +1,67 @@ +--- +title: "Changelog" +--- + + + Changelog + + We've added a changelog to the docs to make it easier to see what's changed between versions and so that you can easily create your own changelog. + + [Read more →](/content/components/update) + + + + ## Advanced Footer + + Advanced Footer + + You can now add more links to the standard footer. This upgrade + provides more consistency between landing pages and docs, or greater customization + if you want to spotlight specific pages like socials or status logs. + + [Read October updates →](/changelog/2024-10) + + + + ## Custom Fonts + + Custom Fonts + + Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand. + + [Read September updates →](/changelog/2024-09) + + + + SEO Improvements + + We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements. + + + + Performance Improvements + + A good developer experience involves low latency and a snappy user experience. + + For majority of our customers this was the case, but as we grew we noticed that some of our customers were really pushing our product to its edges in terms of scale. + + This is why we decided to devote time to making sure customers of all sizes can experience speed. + + - For large projects (~3,000 files), the download step for docs updates is now ~440x faster - a 99.8% time reduction. Across the board, file downloads during updates are now ~5.5x faster - an 81.8% time reduction. + - For API reference pages with complex data types, we have drastically reduced the size of the page. For customers with complex, recursive OpenAPI data types, this means a size reduction of up to 98%. + + [Read August updates →](/changelog/2024-08) + + + + + ## [AI Widget](https://mintlify.com/blog/widget) + + AI Widget + + Documentation is just one part of the solution. The real problem is getting developers to their answers ASAP. + + The Widget is an extension of your docs built to instantly answer your users' questions when and where they need it. + + [Read July updates →](/changelog/2024-07) + diff --git a/images/changelog/advanced-footer.gif b/images/changelog/advanced-footer.gif new file mode 100644 index 000000000..39cc44697 Binary files /dev/null and b/images/changelog/advanced-footer.gif differ diff --git a/images/changelog/changelog.jpg b/images/changelog/changelog.jpg new file mode 100644 index 000000000..7bef8f813 Binary files /dev/null and b/images/changelog/changelog.jpg differ diff --git a/images/changelog/custom-fonts.jpeg b/images/changelog/custom-fonts.jpeg new file mode 100644 index 000000000..fd1233f61 Binary files /dev/null and b/images/changelog/custom-fonts.jpeg differ diff --git a/images/changelog/landing-page.jpeg b/images/changelog/landing-page.jpeg new file mode 100644 index 000000000..80af7a282 Binary files /dev/null and b/images/changelog/landing-page.jpeg differ diff --git a/images/changelog/performance-improvements.png b/images/changelog/performance-improvements.png new file mode 100644 index 000000000..7f2d46d10 Binary files /dev/null and b/images/changelog/performance-improvements.png differ diff --git a/images/changelog/seo-improvements.jpeg b/images/changelog/seo-improvements.jpeg new file mode 100644 index 000000000..20e772ec6 Binary files /dev/null and b/images/changelog/seo-improvements.jpeg differ diff --git a/images/changelog/widget.png b/images/changelog/widget.png new file mode 100644 index 000000000..e1429dbfe Binary files /dev/null and b/images/changelog/widget.png differ diff --git a/mint.json b/mint.json index 839c52185..90b2a5c67 100644 --- a/mint.json +++ b/mint.json @@ -58,6 +58,10 @@ { "name": "Advanced", "url": "advanced" + }, + { + "name": "Changelog", + "url": "changelog" } ], "navigation": [ @@ -219,6 +223,27 @@ "content/components/expandables", "content/components/sticky-examples" ] + }, + { + "group": "", + "pages": ["changelog/overview"] + }, + { + "group": "Product Updates", + "pages": [ + "changelog/2024-10", + "changelog/2024-09", + "changelog/2024-08", + "changelog/2024-07" + ] + }, + { + "group": "Launch Weeks", + "pages": [ + "changelog/lw/3", + "changelog/lw/2", + "changelog/lw/1" + ] } ], "footer": { diff --git a/quickstart.mdx b/quickstart.mdx index 5547918f6..49500b42e 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,6 +4,13 @@ description: "Start building modern documentation in under five minutes" icon: "rocket" --- +```json hello world {2} +{ + "hello": "world", + "foo": "bar" +} +``` +