Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@markdown-confluence/lib

markdown-confluence412Apache 2.05.5.2TypeScript support: included

This library allows you to publish your notes to Confluence

markdown, markdown-confluence, confluence, adf, atlassian, atlassian-document-format, publish-confluence, convert-markdown, obsidian-confluence, obsidian-plugin

readme

🌙 @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! 🛠️

changelog

Changelog

5.5.2 (2023-09-24)

Bug Fixes

  • Downgrade @atlaskit/adf-schema to fix issue (914d324)

5.5.1 (2023-09-24)

Bug Fixes

  • bump markdown-it-table to v4.1.1 (806eabe)

Dependencies

  • deps: bump @atlaskit/adf-schema from 25.10.1 to 26.2.1 (6bbf385)
  • deps: bump @atlaskit/adf-schema from 26.2.1 to 26.3.0 (6ef97ad)
  • deps: bump @atlaskit/adf-schema from 26.4.1 to 29.2.0 (db2745c)
  • deps: bump @atlaskit/adf-schema in /packages/lib (b98b6fb)
  • deps: bump @atlaskit/adf-utils from 18.4.2 to 19.0.0 (3a2fae1)
  • deps: bump @atlaskit/editor-common from 74.29.0 to 74.34.4 (62a82c6)
  • deps: bump @atlaskit/editor-common from 74.7.8 to 74.29.0 (c543b7b)
  • deps: bump @atlaskit/editor-common in /packages/lib (8f78eaf)
  • deps: bump @atlaskit/editor-json-transformer from 8.10.3 to 8.10.4 (1803259)
  • deps: bump @atlaskit/editor-json-transformer from 8.10.4 to 8.10.9 (aa3797f)
  • deps: bump @atlaskit/editor-json-transformer from 8.9.4 to 8.10.3 (76ed649)
  • deps: bump markdown-it-table from 2.0.4 to 4.1.0 (12d7a43)
  • deps: bump prosemirror-model and @types/prosemirror-model (37d6299)

5.5.0 (2023-06-29)

Features

  • FolderNote: Add README.md and readme.md as options for folder note file names (81ee277)

Bug Fixes

  • yargs is a dep of lib not cli (aca0a8b)

Dependencies

  • deps: bump @atlaskit/adf-schema from 25.6.2 to 25.6.4 (fa96d3d)
  • deps: bump @atlaskit/adf-utils from 18.2.1 to 18.2.3 (ebc6895)
  • deps: bump @atlaskit/adf-utils from 18.4.1 to 18.4.2 (2d63294)
  • deps: bump @atlaskit/editor-common from 72.9.0 to 74.0.1 (769f692)
  • deps: bump @atlaskit/editor-common from 74.1.1 to 74.2.1 (366135b)
  • deps: bump @atlaskit/editor-common from 74.2.1 to 74.7.8 (6287545)
  • deps: bump @atlaskit/editor-json-transformer from 8.8.4 to 8.9.1 (cc6b4a9)
  • deps: bump @atlaskit/editor-json-transformer from 8.9.1 to 8.9.3 (ce755a7)
  • deps: bump @atlaskit/editor-json-transformer from 8.9.3 to 8.9.4 (dee45c7)
  • deps: bump formdata-node from 5.0.0 to 5.0.1 (16322c8)
  • deps: bump glob from 10.2.2 to 10.2.4 (94bbf5b)
  • deps: bump glob from 10.2.4 to 10.2.7 (ecb7c77)
  • deps: bump prosemirror-markdown from 1.10.1 to 1.11.0 (9d6ac07)

5.4.0 (2023-05-12)

Features

  • Handle 404 when pageId included in YAML. Set to not publish and remove bad pageId (33dde01)

5.3.0 (2023-05-11)

Features

  • Move ImageUpload and MermaidRendering to plugins to allow for more plugins easily (cfae670)

Bug Fixes

  • Handle relative paths for images (dbaba70)

5.2.6 (2023-05-11)

Bug Fixes

5.2.5 (2023-05-10)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.2.4 (2023-05-10)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.2.3 (2023-05-10)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.2.2 (2023-05-10)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.2.1 (2023-05-10)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.2.0 (2023-05-09)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.1.0 (2023-05-09)

Features

  • Add support for mentions (f17dd84)
  • ADF To Markdown (7257893)
  • Diff page details to see if they have changed. If so then publish page. (7e30ca8)
  • Handle smartcards storing URL without page name on the end (d489f83)

Bug Fixes

  • Add keywords to lib package (a3043b0)
  • Circular imports (4f49798)
  • Fix issues with puppeteer rendering (01824b6)
  • Move SettingsLoaders to own files to help with TreeShaking (f241a11)
  • Remove debug console.log (bb56ed9)
  • Replace all spaces not just first one (c01ae97)
  • Settings path (d1c43e6)
  • Tests (4f91706)

5.0.1 (2023-05-03)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

5.0.0 (2023-05-03)

Features

  • Enable and fix all strict type checks (c16ee2d)
  • Mark lib as sideEffects: false to help treeshaking (1a622e3)

Bug Fixes

  • Add settings to MdToADF Tests (2c58c51)
  • frontmatterHeader adds content direct to ADF instead of Markdown now (1230878)
  • ts errors in tests (21f640e)

Documentation

  • Add README.md files to all NPM Packages (75c4781)

4.9.0 (2023-04-30)

Features

  • Add support for "index.md" as a folder file (f598074)

Bug Fixes

  • Bash to shell language map (28ae75e)

4.8.0 (2023-04-30)

Features

  • Add new setting to allow you to use the first heading as the page title. (ec4e426)

4.7.5 (2023-04-30)

Bug Fixes

  • Handle #hash links better for names that have spaces and handle internal links (7ad345a)

4.7.4 (2023-04-29)

Bug Fixes

  • Check for duplicate page titles not file names. (540b1f9)

4.7.3 (2023-04-29)

Bug Fixes

  • Replace spaces in hashFragment not linkToPage (ed446e8)

4.7.2 (2023-04-28)

Bug Fixes

  • Don't specify default for contentRoot on CommandLineArgumentSettingsLoader. (ec8c338)

4.7.1 (2023-04-28)

Bug Fixes

  • Update the common path to include parent (076effd)

4.7.0 (2023-04-28)

Features

  • Add links to updated pages on Completed Dialog (65c1a42)

Bug Fixes

  • Replace spaces with - to match what confluence uses. (92b9d2d)
  • Wrap check for file in try catch to report the errors better (3fabce0)

4.6.4 (2023-04-28)

Bug Fixes

  • Don't load settings when first initialising Publisher. Fixes issue when no settings available in set up situation. (ceb21e7)
  • My bad (1acc9b8)
  • Remove debug console.logs (f89e617)

4.6.3 (2023-04-28)

Bug Fixes

  • Wrong Ordering of AutoSettingsLoader Loaders (4b1dc22)

4.6.2 (2023-04-28)

Bug Fixes

4.6.1 (2023-04-28)

Bug Fixes

  • Temp hack to show all files to be published (d3539e9)

4.6.0 (2023-04-28)

Features

  • Add "." option to folderToPublish to allow publishing whole contentRoot (54c53ac)

4.5.0 (2023-04-28)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.4.0 (2023-04-27)

Features

  • Allow ConfigFile path to be provided as env var "CONFLUENCE_CONFIG_FILE" (1311a93)

4.3.0 (2023-04-27)

Features

  • Allow setting content root for FilesystemAdaptor (d008f29)

Bug Fixes

  • If environment variable is empty or "" then don't use. (b0b7684)
  • Trim and add back the contentRoot (c48a9c0)

Dependencies

  • deps: bump @atlaskit/adf-utils in /packages/lib (3b5ae81)
  • deps: bump @atlaskit/editor-json-transformer from 8.8.3 to 8.8.4 (b9a4496)

4.2.8 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.7 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.6 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.5 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.4 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.3 (2023-04-26)

Bug Fixes

4.2.2 (2023-04-26)

Bug Fixes

  • Rename links to align with repo rename (742e98c)

4.2.1 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.2.0 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.1.1 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.1.0 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.0.4 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.0.3 (2023-04-26)

Bug Fixes

  • Update Token to support packages (73d3b54)

4.0.2 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.0.1 (2023-04-26)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

4.0.0 (2023-04-26)

⚠ BREAKING CHANGES

  • No longer bundling the lib package to help with tree shaking and code navigation

Features

3.7.0 (2023-04-24)

Features

  • Ignore comments when comparing pages to see if page has changed (8cedbed)
  • Make ADF the same as what Confluence returns. (a223c72)
  • Map Inline Comments with best effort (b1d8db3)

Bug Fixes

  • Add category when uploading Sarif file (3fb888b)

3.6.1 (2023-04-21)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

3.6.0 (2023-04-21)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

3.5.0 (2023-04-21)

Features

  • Custom ADF via Codeblock and adf language (8e91630)

Bug Fixes

  • Add missing homepage and bugs to package.json (c920345)

3.4.1 (2023-04-20)

Bug Fixes

  • Add repository information for providence (362e025)

3.4.0 (2023-04-20)

Features

  • Add npm provenance (ee76005)
  • blog: Blog support. (e0bdc24)
  • Update Confluence Page Settings Command (a7d395e)
  • Write connie-publish: true to all files that have been published to ensure even if you move the files they still will be published. (a7d395e)

3.3.0 (2023-04-18)

Features

  • Update a page when you are the last modifier (5c42d77)

Bug Fixes

3.2.0 (2023-04-18)

Miscellaneous Chores

  • @markdown-confluence/lib: Synchronize obsidian packages versions

3.1.0 (2023-04-18)

Bug Fixes

Miscellaneous Chores

3.0.1 (2023-04-18)

Bug Fixes

3.0.0 (2023-04-18)

Bug Fixes

Miscellaneous Chores

3.0.0 (2023-04-18)

Bug Fixes

Miscellaneous Chores

3.0.1 (2023-04-18)

Bug Fixes

3.0.0 (2023-04-18)

Miscellaneous Chores