Confluence Integration

Obsidian Downloads:

Copyright © 2022 Atlassian Pty Ltd
Copyright © 2022 Atlassian US, Inc

Welcome to the Markdown to Confluence Tools project! This mono repository contains a collection of tools to convert and publish your Markdown files to Confluence, while using the Atlassian Document Format (ADF). We provide you with an Obsidian plugin, a package CLI, a Docker CLI, a GitHub Action, and a package library.

We focus on providing an opinionated, simple publishing workflow, with Obsidian as the recommended editor. However, you can use our tools with any Markdown files.

All projects within this mono repo use the core package library @markdown-confluence/lib to provide the same features, ensuring consistent results across different interfaces.

Table of Contents

• Features
• Documentation
• Contributing
• License

Features

• Converts Markdown files to Atlassian Document Format (ADF)
• Simple publishing workflow with Obsidian as the recommended editor
• Can be used with any Markdown files
• Supports Obsidian plugin, package CLI, Docker CLI, GitHub Action, and package library

Documentation

For detailed installation and usage instructions, please visit our documentation. Before upgrading from 5.5.2, read the version 6 migration guide. Current CLI, library and Obsidian installation instructions are maintained with the source.

Contributing

Contributions are welcome! If you have a feature request, bug report, or want to improve the plugin, please open an issue or submit a pull request on the GitHub repository.

Run vp run test:integration for a build and integration smoke test. The testing guide covers isolated npm consumers, live Confluence, Docker, and the dedicated Obsidian test vault.

License

This project is licensed under the Apache 2.0 License.

Disclaimer:

The Apache license is only applicable to the Obsidian Confluence Integration (“Integration“), not to any third parties' services, websites, content or platforms that this Integration may enable you to connect with. In another word, there is no license granted to you by the above identified licensor(s) to access any third-party services, websites, content, or platforms. You are solely responsible for obtaining licenses from such third parties to use and access their services and to comply with their license terms. Please do not disclose any passwords, credentials, or tokens to any third-party service in your contribution to this Obsidian Confluence Integration project.”

See Kroki diagrams to render kroki-* fences through a trusted server in the CLI or Obsidian.