markdown-to-confluence

# Create a markdown file named 'my_doc.md' # Example content: # # My Awesome Documentation # This is a paragraph with **bold** text. # # ## Section 1 # - Item 1 # - Item 2 import os # Set environment variables for Confluence authentication # Replace with your actual values or ensure they are set in your environment os.environ['ATLASSIAN_ORGNAME'] = os.environ.get('ATLASSIAN_ORGNAME', 'your_organization') # e.g., 'yourcompany' for yourcompany.atlassian.net os.environ['ATLASSIAN_USERNAME'] = os.environ.get('ATLASSIAN_USERNAME', 'your_confluence_email') os.environ['ATLASSIAN_API_KEY'] = os.environ.get('ATLASSIAN_API_KEY', 'your_atlassian_api_key') # To publish 'my_doc.md' to the 'DOC' space in Confluence, using the CLI: # Ensure 'md-to-conf' is available in your PATH after installation # Example using subprocess (or run directly in your shell): import subprocess markdown_file = "my_doc.md" confluence_space_key = "DOC" # Create a dummy markdown file for the example with open(markdown_file, "w") as f: f.write("# My Awesome Documentation\n") f.write("This is a paragraph with **bold** text.\n\n") f.write("## Section 1\n") f.write("- Item 1\n") f.write("- Item 2\n") print(f"Attempting to publish {markdown_file} to Confluence space {confluence_space_key}...") try: # Using the command-line interface directly command = [ "md-to-conf", markdown_file, confluence_space_key, "--orgname", os.environ['ATLASSIAN_ORGNAME'], "--username", os.environ['ATLASSIAN_USERNAME'], "--apikey", os.environ['ATLASSIAN_API_KEY'], "--verbose" # Add for detailed output during publishing ] # For security, avoid passing sensitive data directly in `shell=True` process = subprocess.run(command, capture_output=True, text=True, check=True) print("Publishing successful (or simulated if --simulate was used).") print("STDOUT:", process.stdout) print("STDERR:", process.stderr) except subprocess.CalledProcessError as e: print(f"Error publishing: {e}") print("STDOUT:", e.stdout) print("STDERR:", e.stderr) print("Hint: Check your Confluence credentials, organization name, and space key.") print("Also ensure the Confluence API key has sufficient permissions.") except FileNotFoundError: print("Error: 'md-to-conf' command not found. Is markdown-to-confluence installed and in your PATH?") # Clean up dummy file os.remove(markdown_file)