open-index/open-npm huggingface dataset:
npm package: @markdown-confluence/cli
Description: This CLI allows you to publish your notes to Confluence
Author: andymac4182
Latest version: 5.5.2

# @markdown-confluence/cli

`@markdown-confluence/cli` is a powerful tool that allows you to publish your markdown files as Confluence pages. It is designed to work seamlessly in various environments, including NPM CLI, Docker Container, and GitHub Actions, enabling you to use your docs wherever you need them. Comprehensive documentation for the tool can be found at [https://markdown-confluence.com/](https://markdown-confluence.com/).

## Usage Examples

### CLI

**Example setup**

`.markdown-confluence.json`:

```json
{
  "confluenceBaseUrl": "https://markdown-confluence.atlassian.net",
  "confluenceParentId": "524353",
  "atlassianUserName": "andrew.mcclenaghan@gmail.com",
  "folderToPublish": "."
}
```

**Environment Variables**

macOS / Linux:

```bash
export ATLASSIAN_API_TOKEN="YOUR API TOKEN"
```

Windows:

```bash
set ATLASSIAN_API_TOKEN="YOUR API TOKEN"
```

[Learn more about `set` command](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/set_1)

**CLI Command**

```bash
npx @markdown-confluence/cli
```

### Docker Container

**Example setup**
```bash
docker run -it --rm -v "$(pwd):/content" -e ATLASSIAN_API_TOKEN ghcr.io/markdown-confluence/publish:latest
```

### GitHub Actions

**Example setup**

`.github/workflows/publish.yml`:

```yaml
name: Publish to Confluence
on: [push]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
      - name: Publish Markdown to Confluence
        uses: markdown-confluence/publish@v1
        with:
          atlassianApiToken: ${{ secrets.ATLASSIAN_API_TOKEN }}
```

**Environment Variables**

Add your API token as a secret in your GitHub repository settings:

1. Go to your repository's `Settings` tab.
2. Click on `Secrets` in the left sidebar.
3. Click on `New repository secret`.
4. Name it `ATLASSIAN_API_TOKEN` and enter your API token as the value.
5. Click on `Add secret`.
npm package: @markdown-confluence/lib
Description: This library allows you to publish your notes to Confluence
Author: andymac4182
Latest version: 5.5.2

# 🌙 @markdown-confluence/lib - The Sleep-Deprived Engineer's Dream

Hey fellow engineers, I know we've all been there - burning the midnight oil, trying to balance work and family, and somehow still managing to get things done. With a newborn at home, I'm no stranger to the art of staying up all night. That's why I've put together this fantastic library to make your lives a little easier. Say hello to `@markdown-confluence/lib`, the core library for publishing Markdown files to Confluence with some extra goodies to make your life better. Seriously, this thing is like a double shot of espresso for your markdown-to-Confluence pipeline.

## 🚀 Features

* Wikilinks: Need to connect pages or sections? Piece of cake.
* Image uploading: Wave goodbye to manual image management.
* Mermaid diagram uploading: Beautiful diagrams with zero hassle.
* Comment preserving: Because we all need to remember why we did *that*.
* Diffing: No unnecessary uploads, saving you time and bandwidth.
* Integration tests: Ensuring the Atlassian Document Format (ADF) round trips like a champ.

## 🧪 Built With

* TypeScript: Robust, scalable, and oh-so-readable.

## 🎁 Batteries Included

This library is designed to be opinionated and feature-rich. Think of it as a Swiss Army knife for your markdown-to-Confluence needs. It's not just about getting the job done; it's about getting it done *right*, with a set of tools that make your life easier.

## 😴 Sleep Tight

So, to all my fellow sleep-deprived engineers, I hope `@markdown-confluence/lib` makes your nights a little less restless. Go on, give it a try, and let it work its magic on your markdown files. And remember, you're doing great - we're all in this together.

Happy coding! 🛠️
npm package: @markdown-confluence/mermaid-electron-renderer
Description: This library allows you to publish your notes to Confluence
Author: andymac4182
Latest version: 5.5.2

# @markdown-confluence/mermaid-electron-renderer

[![GitHub license](https://img.shields.io/github/license/markdown-confluence/mermaid-electron-renderer)](https://github.com/markdown-confluence/markdown-confluence/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/v/@markdown-confluence/mermaid-electron-renderer)](https://www.npmjs.com/package/@markdown-confluence/mermaid-electron-renderer)
[![npm](https://img.shields.io/npm/dw/@markdown-confluence/mermaid-electron-renderer)](https://www.npmjs.com/package/@markdown-confluence/mermaid-electron-renderer)

This package is a library designed to be used with `@markdown-confluence/lib` for rendering Mermaid charts as images in Electron-based applications. Originally developed for use with Obsidian.md, it can be used in any Electron renderer code to render Mermaid charts to images.
npm package: @markdown-confluence/mermaid-puppeteer-renderer
Description: This library allows you to publish your notes to Confluence
Author: andymac4182
Latest version: 5.5.2

# @markdown-confluence/mermaid-puppeteer-renderer

[![GitHub license](https://img.shields.io/github/license/markdown-confluence/markdown-confluence)](https://github.com/markdown-confluence/markdown-confluence/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/v/@markdown-confluence/mermaid-puppeteer-renderer)](https://www.npmjs.com/package/@markdown-confluence/mermaid-puppeteer-renderer)
[![npm](https://img.shields.io/npm/dw/@markdown-confluence/mermaid-puppeteer-renderer)](https://www.npmjs.com/package/@markdown-confluence/mermaid-puppeteer-renderer)

This package is a library designed to be used with `@markdown-confluence/lib` for rendering Mermaid charts as images using [Puppeteer](https://github.com/puppeteer/puppeteer) in CLI applications.