>[!warning] This document is for nerds! HelpMate is designed to be extended with the valuable documentation created by the community for plugins, themes, and CSS Snippets. In this document, you will learn how to enable your tools to integrate with HelpMate. The good news is it is very simple! # Plugins Adding support for HelpMate in your plugin is easy. Add another key to your manifest.json file that is part of the plugin downloaded to the user's vault. Add a key named helpUrl with the URL to the help site in the manifest. For example: ```json "helpUrl": "https://tfthacker.com/HelpMate" ``` The following is the manifest file for HelpMate: ![[helpmate manifest for plugin.png|500]] As always, it is highly recommended that the URL be a secure HTTPS site. >[!info] Reminder: Include manifest in the release >This manifest needs to be included in the plugin release that is downloaded by the user when the plugin is installed or updated. >[!warning] Mobile Support >While HelpMate works on mobile, not all sites will work on mobile even though they work on Obsidian desktop. # Themes Themes also require a manifest.json file. For this reason, HelpMate uses the same logic for registering a helpUrl in the theme's manifest as is done for plugins. For example, the following is how a theme manifest would look with a helpUrl key: ![[helpmate theme.png|400]] # CSS Snippets CSS Snippets does not have manifest.json files. However, HelpMate can also display help sites for these files if the CSS Snippet author includes a specially formatted comment in their snippet. For Example: ```css /* [helpUrl: Canvas Candy|https://tfthacker.com/canvas-candy] */ ``` Let us break this down: In a comment, include between two brackets a helpUrl followed by a colon, the name of the help that should appear in HelpMate followed by a | and then the URL to the help site. The format is: ``` [helpUrl: Title|URL] ``` # The future of helpUrl I strongly believe in the importance of good documentation and help for users. I think all of us, as developers, should make it a priority to document our solutions. With that in mind, I would love to see the concept of HelpMate integrated into Obsidian. For sure, the Obsidian could do a much better job than I did. With that in mind, I have published a feature request to make the helpUrl concept a native feature. Add your vote to this request at [Links to Help and Manuals for Plugins and Themes - Feature requests - Obsidian Forum](https://forum.obsidian.md/t/links-to-help-and-manuals-for-plugins-and-themes/70733).