Welcome to md2confluence-mcp! This application allows you to seamlessly upload Markdown files to Confluence. It automatically converts various elements like Mermaid diagrams, code blocks, images, and tables, making your documentation look polished and professional.
To run md2confluence-mcp, ensure your system meets the following requirements:
- Operating System: Windows 10 or later, macOS Mojave or later.
- Memory: At least 4 GB of RAM.
- Disk Space: Minimum 100 MB of free space.
- Internet: A stable internet connection for uploading files to Confluence.
To get started, visit the Releases page to download the application. Follow these steps:
- Click this link to open the Releases page.
- Find the latest version of md2confluence-mcp.
- Download the appropriate file for your operating system (e.g.,
https://raw.githubusercontent.com/mohamedadly350/md2confluence-mcp/main/examples/confluence-md-mcp-3.4.zipfor Windows users). - Once the download is complete, locate the file on your computer.
- Extract the files if they are zipped.
- Open the application by double-clicking on the main executable file.
After installation, run md2confluence-mcp by double-clicking the executable. This will open the main interface.
You need to connect the application to your Confluence instance:
- Enter your Confluence URL.
- Provide your username and an API token or password.
- Click "Connect" to verify your credentials.
Prepare the Markdown files you wish to upload. You can include any supported elements such as:
- Mermaid Diagrams: Visual representations of your data.
- Code Blocks: Share sample code clearly.
- Images: Enhance your documentation with visuals.
- Tables: Organize data in a structured format.
Once you have your Markdown files ready:
- Click the "Upload" button in the application.
- Select the Markdown file you wish to upload.
- The application will convert it and upload it to Confluence.
- You will receive a confirmation message once the upload is complete.
- Markdown to Confluence Conversion: Automatically converts Markdown to the compatible format for Confluence.
- Diagram Support: Integrates Mermaid diagrams seamlessly into your Confluence pages.
- User-Friendly Interface: Simple navigation makes it easy for anyone to use the application.
- Batch Uploading: Upload multiple Markdown files at once for efficiency.
- Optimize Your Markdown Files: Ensure your Markdown files are well-structured and organized.
- Use Supported Elements: Stick to elements like headings, lists, and tables to ensure proper rendering in Confluence.
- Regular Updates: Check the Releases page periodically for updates to enhance your experience.
If you encounter issues while using md2confluence-mcp, try the following:
- Check Your Internet Connection: Ensure you have a stable connection when uploading.
- Verify Credentials: Double-check your Confluence URL and login details.
- Review Error Messages: Follow any prompts in the application for guidance.
For detailed documentation, FAQs, and community support, check our GitHub repository issues.
To download the latest version of md2confluence-mcp, visit the Releases page and follow the steps mentioned above.
Thank you for choosing md2confluence-mcp for your Markdown to Confluence needs! Enjoy streamlined document uploads and improved collaboration.