Transform your Confluence pages into beautiful React components! This project demonstrates how to seamlessly integrate Confluence content into modern web applications.
Disclaimer: This is an unofficial project, not affiliated with Atlassian.
This repository contains:
- packages/core -
confluence-mirror-core: Framework-agnostic Confluence API & ADF processing - demo/ - Complete implementation example with reusable React components
# Clone and run the demo
git clone https://github.com/Gravitek-io/confluence-mirror
cd confluence-mirror
npm install
npm run devVisit http://localhost:3000 to see the demo in action.
Note: Before running the demo, configure authentication. See Authentication Setup below.
The project supports two authentication methods with Atlassian Confluence:
- Uses Atlassian service accounts
- More secure with short-lived tokens
- Auto-refreshing authentication
- Automatic Cloud ID detection
CONFLUENCE_OAUTH_CLIENT_ID=your_client_id
CONFLUENCE_OAUTH_CLIENT_SECRET=your_client_secret- Uses personal Atlassian account
- Email + API token
- Simpler setup for development
CONFLUENCE_BASE_URL=https://your-domain.atlassian.net
CONFLUENCE_EMAIL=your.email@domain.com
CONFLUENCE_API_KEY=your_api_tokenDetailed setup instructions: See demo/README.md
# Install the published core package
npm install confluence-mirror-core
# Copy reusable components from demo
cp -r demo/src/components/confluence/ your-project/src/components/
cp demo/src/lib/confluence.ts your-project/src/lib/Fork this repository and customize the demo app for your needs.
Framework-agnostic core logic for Confluence integration:
- ✅ Confluence REST API client
- ✅ ADF (Atlas Document Format) processing
- ✅ Media URL rewriting
- ✅ Table of contents extraction
- ✅ TypeScript types
Contributions welcome! Please read our contributing guidelines and submit pull requests.
Apache-2.0 © Gravitek