This repository contains a set of tools that can be used to interact with Confluence.
They are distributed as NPM packages. Please refer to the documentation of each package for more information.
- Markdown Confluence Sync: A tool to synchronize a folder containing Markdown files with Confluence pages. Supports Mermaid diagrams and per-page configuration using frontmatter metadata. Works great with Docusaurus.
- Confluence Sync: A tool that creates/updates/deletes Confluence pages based on a list of objects containing the page contents. Supports nested pages and attachments upload.
These tools are used by the main packages, but are also published as separate packages:
- child-process-manager: A tool to manage child processes. Useful to execute shell commands from tests and check their output, for example.
Some other components in the repository are not published, because they are used only in the development of the main packages:
- eslint-config: Base configuration for ESLint, enabling to extend it on each different component.
- cspell-config: Base configuration for cspell, enabling to extend it on each different component.
Please read our Contributing Guidelines for details on how to contribute to this project before submitting a pull request.
This project is licensed under the Apache-2.0 License - see the LICENSE file for details.