Skip to content

Match-Yang/FlashMintlify

Repository files navigation

FlashMintlify

Life is hard, writing should be easy!

A super powerful extension that’ll make your Mintlify writing fly. It comes with intelligent component completion, automatic file reference tracking, smart link validation, and enhanced MDX editing experience.

🌟 Like this tool? Your star is my biggest motivation to keep improving!
👉 Click here to give FlashMintlify a star!
Let more people discover and use the more efficient Mintlify writing experience!

✨ Key Features

Preview in editor

preview_in_editor

🖼️ Visual Page Options Editor

frontmatter_visual_editor

🧩 Visual Component Property Editor

component_attribute_visual_editor

🔥 Slash Commands

Just type "/" to trigger the slash commands and get the following features:

slash_commands

🚀 Intelligent Component Completion

You don't need to remember all the rules!

Just type "<" to trigger the component completion.

components_completion

Just type "```" to trigger the code block completion.

code_block_completion

🔗 Smart Link Management & Validation

Real-time link validation and automatic updates:

  • Internal Link Validation: Validates Mintlify internal links (/path/to/page)
  • Absolute Link Validation: Checks file existence for absolute paths (/images/logo.png)
  • CodeLens Integration: Shows "Open file" buttons for valid internal links
  • Status Bar Indicators: Real-time count of invalid links in current file
  • Auto-Resolution: Automatically tries .mdx, .md, index.mdx, index.md extensions

invalid_internal_link invalid_absolute_link

📁 Advanced File Reference Tracking

Intelligent language service that automatically maintains file references:

  • Auto-Update Imports: Updates MDX imports when files are moved or renamed
  • Auto-Update Links: Updates internal links when files are moved or renamed
  • Bulk Operations: Handles folder renames with automatic reference updates
  • Navigation Sync: Updates docs.json navigation when files are moved
  • Real-time Analysis: Tracks file dependencies across your documentation

update_references

🎯 Efficient Context Menu Actions

copy_internal_link copy_import_statement

🪄 Efficient CodeLens Actions

  • Open File: Open the file that the internal link points to.

open_file

  • Generate and copy heading anchor: Using fixed anchor can avoid the failure to jump through the anchor after modifying the heading.

generate_and_copy_heading_anchor

🛠️ System Requirements

  • VS Code: 1.73.0 or higher
  • Project Structure: Mintlify project with docs.json configuration
  • File Types: .md, .mdx, .json, .yaml, .yml files

🤝 Contributing

We welcome contributions! This extension is open source and available on GitHub.

📄 License

MIT License - see LICENSE file for details.


Made with ❤️ for the Mintlify community

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages