/markdown-confluence

Publish your Markdown Files to Confluence

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Markdown to Confluence Tools

Discord
OpenSSF Scorecard Known Vulnerabilities GitHub Workflow Status (with branch) Lines of code GitHub manifest version
Conventional Commits

Obsidian Downloads: GitHub all releases

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, an npm CLI, a Docker CLI, a GitHub Action, and an npm 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 npm library @markdown-confluence/lib to provide the same features, ensuring consistent results across different interfaces.

Table of Contents

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, npm CLI, Docker CLI, GitHub Action, and npm library

Documentation

For detailed installation and usage instructions, please visit our documentation.

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.

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.”