Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/markdown-confluence/markdown-confluence

Publish your Markdown Files to Confluence
https://github.com/markdown-confluence/markdown-confluence

confluence confluence-markup confluence-plugin markdown markdown-to-confluence obsidian-md obsidian-plugin wiki

Last synced: about 1 month ago
JSON representation

Publish your Markdown Files to Confluence

Host: GitHub
URL: https://github.com/markdown-confluence/markdown-confluence
Owner: markdown-confluence
License: apache-2.0
Created: 2022-11-12T12:31:11.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-06-05T14:05:42.000Z (4 months ago)
Last Synced: 2024-08-01T04:29:35.944Z (about 2 months ago)
Topics: confluence, confluence-markup, confluence-plugin, markdown, markdown-to-confluence, obsidian-md, obsidian-plugin, wiki
Language: TypeScript
Homepage: https://markdown-confluence.com
Size: 7.86 MB
Stars: 138
Watchers: 3
Forks: 33
Open Issues: 89
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

jimsghstars - markdown-confluence/markdown-confluence - Publish your Markdown Files to Confluence (TypeScript)

README

        # Markdown to Confluence Tools

[![Discord](https://img.shields.io/discord/1102841755646316576)](https://discord.gg/3ZVEc3S48x)  

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/markdown-confluence/markdown-confluence/badge)](https://api.securityscorecards.dev/projects/github.com/markdown-confluence/markdown-confluence)

[![Known Vulnerabilities](https://snyk.io/test/github/markdown-confluence/markdown-confluence/badge.svg)](https://snyk.io/test/github/markdown-confluence/markdown-confluence)

![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/markdown-confluence/markdown-confluence/release-please.yml)

![Lines of code](https://img.shields.io/tokei/lines/github/markdown-confluence/markdown-confluence)

![GitHub manifest version](https://img.shields.io/github/manifest-json/v/markdown-confluence/obsidian-integration)  

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

Obsidian Downloads: ![GitHub all releases](https://img.shields.io/github/downloads/markdown-confluence/obsidian-integration/total)

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](https://obsidian.md/) 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](https://www.npmjs.com/package/@markdown-confluence/lib) to provide the same features, ensuring consistent results across different interfaces.

## Table of Contents

- [Features](#features)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [License](#license)

## Features

- Converts Markdown files to [Atlassian Document Format (ADF)](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)

- Simple publishing workflow with [Obsidian](https://obsidian.md/) 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](https://markdown-confluence.com/).

## 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](https://github.com/markdown-confluence/markdown-confluence/blob/main/LICENSE) 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.”