Giters

jevfok / mark

Sync your markdown files with Confluence pages.

Home Page:https://samizdat.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mark

All Contributors

Mark — a tool for syncing your markdown documentation with Atlassian Confluence pages.

Read the blog post discussing the tool — https://samizdat.dev/use-markdown-for-confluence/

This is very useful if you store documentation to your software in a Git repository and don't want to do an extra job of updating Confluence page using a tinymce wysiwyg enterprise core editor which always breaks everything.

Mark does the same but in a different way. Mark reads your markdown file, creates a Confluence page if it's not found by its name, uploads attachments, translates Markdown into HTML and updates the contents of the page via REST API. It's like you don't even need to create sections/pages in your Confluence anymore, just use them in your Markdown documentation.

Mark uses an extended file format, which, still being valid markdown, contains several HTML-ish metadata headers, which can be used to locate page inside Confluence instance and update it accordingly.

File in the extended format should follow the specification:

<!-- Space: <space key> -->
<!-- Parent: <parent 1> -->
<!-- Parent: <parent 2> -->
<!-- Title: <title> -->
<!-- Attachment: <local path> -->
<!-- Label: <label 1> -->
<!-- Label: <label 2> -->

<page contents>

There can be any number of Parent headers, if Mark can't find specified parent by title, Mark creates it.

Also, optional following headers are supported:

<!-- Layout: (article|plain) -->
  • (default) article: content will be put in narrow column for ease of reading;
  • plain: content will fill all page;
<!-- Type: (page|blogpost) -->
  • (default) page: normal Confluence page - defaults to this if omitted
  • blogpost: Blog post in Space. Cannot have Parent(s)
<!-- Sidebar: <h2>Test</h2> -->

Setting the sidebar creates a column on the right side. You're able to add any valid HTML content. Adding this property sets the layout to article.

Mark supports Go templates, which can be included into article by using path to the template relative to current working dir, e.g.:

<!-- Include: <path> -->

Templates can accept configuration data in YAML format which immediately follows the Include tag:

<!-- Include: <path>
     <yaml-data> -->

Mark also supports attachments. The standard way involves declaring an Attachment along with the other items in the header, then have any links with the same path:

<!-- Attachment: <path-to-image> -->

<beginning of page content>

An attached link is [here](<path-to-image>)

NOTE: Be careful with Attachment! If your path string is a subset of another longer string or referenced in text, you may get undesired behavior.

Mark also supports macro definitions, which are defined as regexps which will be replaced with specified template:

<!-- Macro: <regexp>
     Template: <path>
     <yaml-data> -->

Capture groups can be defined in the macro's which can be later referenced in the <yaml-data> using ${<number>} syntax, where <number> is number of a capture group in regexp (${0} is used for entire regexp match), for example:

  <!-- Macro: MYJIRA-\d+
       Template: ac:jira:ticket
       Ticket: ${0} -->

Code Blocks

If you have long code blocks, you can make them collapsible with the Code Block Macro:

```bash collapse
...
some long bash code block
...
```

And you can also add a title:

```bash collapse title Some long long bash function
...
some long bash code block
...
```

You can collapse or have a title without language or any mix, but the language must stay in the front if it is given:

[<language>] ["collapse"] ["title" <your title>]

Template & Macros

By default, mark provides several built-in templates and macros:

Template & Macros Usecases

Insert Disclaimer

disclaimer.md

**NOTE**: this document is generated, do not edit manually.

article.md

<!-- Space: TEST -->
<!-- Title: My Article -->

<!-- Include: disclaimer.md -->

This is my article.

Insert Status Badge

article.md

<!-- Space: TEST -->
<!-- Title: TODO List -->

<!-- Macro: :done:
     Template: ac:status
     Title: DONE
     Color: Green -->

<!-- Macro: :todo:
     Template: ac:status
     Title: TODO
     Color: Blue -->

* :done: Write Article
* :todo: Publish Article

Insert Colored Text Box

article.md

<!-- Space: TEST -->
<!-- Title: Announcement -->

<!-- Macro: :box:(.+):(.*):(.+):
     Template: ac:box
     Icon: true
     Name: ${1}
     Title: ${2}
     Body: ${3} -->

:box:info::Foobar:
:box:tip:Tip of day:Foobar:
:box:note::Foobar:
:box:warning:Alert!:Foobar:

Insert Table of Contents

<!-- Include: ac:toc -->

If default TOC looks don't find a way to your heart, try parametrizing it, for example:

<!-- Macro: :toc:
     Template: ac:toc
     Printable: 'false'
     MinLevel: 2 -->

# This is my nice title

:toc:

You can call the Macro as you like but the Template field must have the ac:toc value. Also, note the single quotes around 'false'.

See Confluence TOC Macro for the list of parameters - keep in mind that here they start with capital letters. Every skipped field will have the default value, so feel free to include only the ones that you require.

Insert Jira Ticket

article.md

<!-- Space: TEST -->
<!-- Title: TODO List -->

<!-- Macro: MYJIRA-\d+
     Template: ac:jira:ticket
     Ticket: ${0} -->

See task MYJIRA-123.

Installation

Go Get

go get -v github.com/kovetskiy/mark

Releases

Download a release from the Releases page

Docker

$ docker run --rm -i kovetskiy/mark:latest mark <params>

Usage

mark [options] [-u <username>] [-p <password>] [-k] [-l <url>] -f <file>
mark [options] [-u <username>] [-p <password>] [-k] [-b <url>] -f <file>
mark [options] [-u <username>] [-p <password>] [--drop-h1] -f <file>
mark -v | --version
mark -h | --help
  • -u <username> — Use specified username for updating Confluence page.
  • -p <password> — Use specified password for updating Confluence page. Specify - as password to read password from stdin.
  • -l <url> — Edit specified Confluence page. If -l is not specified, file should contain metadata (see above).
  • -b <url> or --base-url <url> – Base URL for Confluence. Alternative option for base_url config field.
  • -f <file> — Use specified markdown file(s) for converting to html. Supports file globbing patterns (needs to be quoted).
  • -c <path> or --config <path> — Specify a path to the configuration file.
  • -k — Lock page editing to current user only to prevent accidental manual edits over Confluence Web UI.
  • --drop-h1 – Don't include H1 headings in Confluence output.
  • --dry-run — Show resulting HTML and don't update Confluence page content.
  • --minor-edit — Don't send notifications while updating Confluence page.
  • --trace — Enable trace logs.
  • -v | --version — Show version.
  • -h | --help — Show help screen and call 911.

You can store user credentials in the configuration file, which should be located in ~/.config/mark (or specified via -c --config <path>) with the following format (TOML):

username = "your-email"
password = "password-or-api-key-for-confluence-cloud"
# If you are using Confluence Cloud add the /wiki suffix to base_url
base_url = "http://confluence.local"

NOTE: Labels aren't supported when using minor-edit!

Tricks

Continuous Integration

It's quite trivial to integrate Mark into a CI/CD system, here is an example with Snake CI in case of self-hosted Bitbucket Server / Data Center.

stages:
  - sync

Sync documentation:
  stage: sync
  only:
    branches:
      - main
  image: kovetskiy/mark
  commands:
    - for file in $(find -type f -name '*.md'); do
        echo "> Sync $file";
        mark -u $MARK_USER -p $MARK_PASS -b $MARK_URL -f $file || exit 1;
        echo;
      done

In this example, I'm using the kovetskiy/mark image for creating a job container where the repository with documentation will be cloned to. The following command finds all *.md files and runs mark against them one by one:

for file in $(find -type f -name '*.md'); do
    echo "> Sync $file";
    mark -u $MARK_USER -p $MARK_PASS -b $MARK_URL -f $file || exit 1;
    echo;
done

The following directive tells the CI to run this particular job only if the changes are pushed into the main branch. It means you can safely push your changes into feature branches without being afraid that they automatically shown in Confluence, then go through the reviewal process and automatically deploy them when PR got merged.

only:
  branches:
    - main

File Globbing

Rather than running mark multiple times, or looping through a list of files from find, you can use file globbing (i.e. wildcard patterns) to match files in subdirectories. For example:

mark -f "helpful_cmds/*.md"

Issues, Bugs & Contributions

I've started the project to solve my own problem and open sourced the solution so anyone who has a problem like me can solve it too. I have no profits/sponsors from this projects which means I don't really prioritize working on this project in my free time. I still check the issues and do code reviews for Pull Requests which means if you encounter a bug in the program, you should not expect me to fix it as soon as possible, but I'll be very glad to merge your own contributions into the project and release the new version.

I try to label all new issues so it's easy to find a bug or a feature request to fix/implement, if you are willing to help with the project, you can use the following labels to find issues, just make sure to reply in the issue to let everyone know you took the issue:

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Stanislav Seletskiy
💻
Nick Klauer
💻
Rolf Ahrenberg
💻
Charles Southerland
💻
Šarūnas Nejus
💻
Alexey Baranov
💻
Anthony Barbieri
💻

Devin Auclair
💻
Gezim Sejdiu
💻
Josip Ćavar
💻
Juho Saarinen
💻
Luke Fritz
💻
Matt Radford
💻
Planktonette
💻

Stefano Teodorani
💻
Tim Schrumpf
💻
Tyler Cole
💻
elgreco247
💻
emead-indeed
💻
Will Hegedus
💻
Leandro Carneiro
💻

beeme1mr
💻
Taldrain
💻
Hugo Cisneiros
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Sync your markdown files with Confluence pages.

https://samizdat.dev

License:Other

Languages

Language:Go 98.1%Language:Makefile 1.5%Language:Dockerfile 0.5%