Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/justmiles/go-markdown2confluence
Push markdown files to Confluence Cloud
https://github.com/justmiles/go-markdown2confluence
Last synced: 6 days ago
JSON representation
Push markdown files to Confluence Cloud
- Host: GitHub
- URL: https://github.com/justmiles/go-markdown2confluence
- Owner: justmiles
- License: mpl-2.0
- Created: 2018-03-26T16:27:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T03:45:39.000Z (9 months ago)
- Last Synced: 2024-08-04T02:10:19.516Z (3 months ago)
- Language: Go
- Size: 2.88 MB
- Stars: 249
- Watchers: 6
- Forks: 51
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown2confluence
Push markdown files to Confluence Cloud
[](https://drone.justmiles.io/justmiles/go-markdown2confluence)
## Installation
Download the [latest
release](https://github.com/justmiles/go-markdown2confluence/releases)
and add the binary in your local `PATH`
- Linux
```shell
curl -LO https://github.com/justmiles/go-markdown2confluence/releases/download/v3.4.6/go-markdown2confluence_3.4.6_linux_x86_64.tar.gz
sudo tar -xzvf go-markdown2confluence_3.4.6_linux_x86_64.tar.gz -C /usr/local/bin/ markdown2confluence
```
- OSX
```shell
curl -LO https://github.com/justmiles/go-markdown2confluence/releases/download/v3.4.6/go-markdown2confluence_3.4.6_darwin_x86_64.tar.gz
sudo tar -xzvf go-markdown2confluence_3.4.6_darwin_x86_64.tar.gz -C /usr/local/bin/ markdown2confluence
```
- Windows
Download [the latest release](https://github.com/justmiles/go-markdown2confluence/releases/download/v3.4.6/go-markdown2confluence_3.4.6_windows_x86_64.tar.gz) and add to your system `PATH`
## Use with Docker
```shell
docker run justmiles/markdown2confluence --version
```
### Build using docker
```shell
docker run -v $PWD:/src -w /src goreleaser/goreleaser --snapshot --skip-publish --rm-dist
```
## Environment Variables
For best practice we recommend you [authenticate using an API token](https://id.atlassian.com/manage/api-tokens).
However, you may also use [Personal Access Tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html),
which may help if your company uses SSO.
- CONFLUENCE_USERNAME - username for Confluence Cloud. When using API tokens set this to your full email.
- CONFLUENCE_PASSWORD - API token or password for Confluence Cloud
- CONFLUENCE_ENDPOINT - endpoint for Confluence Cloud, eg `https://mycompanyname.atlassian.net/wiki`
- CONFLUENCE_ACCESS_TOKEN - Bearer access token to use (instead of API token)
## Usage
```txt
Push markdown files to Confluence Cloud
Usage:
markdown2confluence [flags]
Flags:
-a, --access-token string Confluence access-token. (Alternatively set CONFLUENCE_ACCESS_TOKEN environment variable)
-c, --comment string (Optional) Add comment to page
-d, --debug Enable debug logging
-e, --endpoint string Confluence endpoint. (Alternatively set CONFLUENCE_ENDPOINT environment variable) (default "https://mydomain.atlassian.net/wiki")
-x, --exclude strings list of exclude file patterns (regex) for that will be applied on markdown file paths
-w, --hardwraps Render newlines as
-h, --help help for markdown2confluence
-i, --insecuretls Skip certificate validation. (e.g. for self-signed certificates)
-m, --modified-since int Only upload files that have modifed in the past n minutes
--parent string Optional parent page to nest content under
-p, --password string Confluence password. (Alternatively set CONFLUENCE_PASSWORD environment variable)
-s, --space string Space in which page should be created
-t, --title string Set the page title on upload (defaults to filename without extension)
--use-document-title Will use the Markdown document title (# Title) if available
-u, --username string Confluence username. (Alternatively set CONFLUENCE_USERNAME environment variable)
--version version for markdown2confluence
```
## Examples
Upload a local directory of markdown files called `markdown-files` to Confluence.
```shell
markdown2confluence \
--space 'MyTeamSpace' \
markdown-files
```
Upload the same directory, but only those modified in the last 30 minutes. This is particurlarly useful for cron jobs/recurring one-way syncs.
```shell
markdown2confluence \
--space 'MyTeamSpace' \
--modified-since 30 \
markdown-files
```
Upload a single file
```shell
markdown2confluence \
--space 'MyTeamSpace' \
markdown-files/test.md
```
Upload a directory of markdown files in space `MyTeamSpace` under the parent page `API Docs`
```shell
markdown2confluence \
--space 'MyTeamSpace' \
--parent 'API Docs' \
markdown-files
```
Upload a directory of markdown files in space `MyTeamSpace` under a _nested_ parent page `Docs/API` and _exclude_ mardown files/directories that match `.*generated.*` or `.*temp.md`
```shell
markdown2confluence \
--space 'MyTeamSpace' \
--parent 'API/Docs' \
--exclude '.*generated.*' \
--exclude '.*temp.md' \
markdown-files
```
Upload a directory of markdown files in space `MyTeamSpace` under the parent page `API Docs` and use the markdown _document-title_ instead of the filname as document title (if available) in Confluence.
```shell
markdown2confluence \
--space 'MyTeamSpace' \
--parent 'API Docs' \
--use-document-title \
markdown-files
```
## Enhancements
It is possible to insert Confluence macros using fenced code blocks.
The "language" for this is `CONFLUENCE-MACRO`, exactly like that in all-caps.
Here is an example for a ToC macro using all headlines starting at Level 2:
````markdown
# Title
```CONFLUENCE-MACRO
name:toc
schema-version:1
minLevel:2
```
## Section 1
````
In general almost all macros should be possible.
The general syntax is:
````markdown
```CONFLUENCE-MACRO
name:Name of Macro
schema-version:Schema Version (use `1`)
attribute:Value of Attribute
parameter-name:Value of Parameter
next-parameter:Value of Parameter
```
````
So a fully fledged macro could look like:
````markdown
```CONFLUENCE-MACRO
name:toc
schema-version:1
maxLevel:5
minLevel:2
exclude:Beispiel.*
style:none
type:flat
separator:pipe
```
````
Which will translate to:
```XML
5
2
Beispiel.*
none
flat
pipe
```