🔗 Link Docs

Providee context to your code without cluttering it. Use Link Docs to link your documentation to relevant code files.

How to link your documents

1. Create a folder named docs
2. In the docs folder place your markdown documentation files
3. 🔗Link documentation to code
4. Hover over your code and see your documentation appear!

5. Open up a document preview by pressing Cmd/Ctrl+8

🔗 Different Ways to Link

🗄 Files

At the top of your markdown file, insert:

[](../path/to/file)

Documentation content...

🚨 Do not forget the newline separating the link and the content!

📁 Folders

The link format is the same as above.

⛓ One-to-Many

Link multiple files/directories by listing them.

At the top of your markdown file, insert:

[](../path/to/file)
[](../path/to/folder)
...

Documentation content...

🚨 Do not forget the newline separating the link and the content!

Note: When multiple docs are linked to the same file, the lowest level path will be returned when you press Cmd/Ctrl+8. You can access all the other documents associated with the file by scrolling through the hover.

Known Issues

• Local pictures do not show up in the hover preview

Have feature requests? Email us at hi@mintlify.com or leave an issue on our GitHub

More information

Website | GitHub | Twitter | Discord

Built with 💚 by the Mintlify team