chunpu / markdown2confluence

convert markdown to confluence markup

markdown2confluence

convert markdown to confluence markup

Installation

npm i markdown2confluence -g

Usage

markdown2confluence markdown.md

or

Try in browser http://chunpu.github.io/markdown2confluence/browser/

Document

Confluence Wiki Markup

License

markdown2confluence's Issues

---不能被正确的识别

例如下面的markdown语句：

## 一、如何接入

---

## 二、使用说明

被识别成：

h2. 一、如何接入

----h2. 二、使用说明

识别后的markup在confluence不能达到预期。以上转换来自您的浏览器版，本地没有装npm环境没测试，看到您来自**就用中文发了~

TOC not converted

Table of content are no rendered
-

• Following topics are not converted:

Following topics are not converted:

• TOC
• Images
• Emoji ⚠️
• 
  Line break
• keys.
• task items

Hyperlink Display Text Not Converted

[GitHub Flavored Markdown](https://github.github.com/gfm/)

is converted simply to

[https://github.github.com/gfm/]

NPM audit reported vulnerabilities

Dear,

Some of the dependencies are outdated. Would it be possible to upgrade them to solve npm audit?

Low             Incorrect Handling of Non-Boolean Comparisons During
                  Minification

  Package         uglify-js

  Patched in      >= 2.4.24

  Dependency of   markdown2confluence [dev]

  Path            markdown2confluence > jade > transformers > uglify-js

  More info       https://npmjs.com/advisories/39


  Low             Regular Expression Denial of Service

  Package         uglify-js

  Patched in      >=2.6.0

  Dependency of   markdown2confluence [dev]

  Path            markdown2confluence > jade > transformers > uglify-js

  More info       https://npmjs.com/advisories/48


  Moderate        Regular Expression Denial of Service

  Package         marked

  Patched in      >=0.6.2

  Dependency of   markdown2confluence [dev]

  Path            markdown2confluence > marked

  More info       https://npmjs.com/advisories/812


  Low             Regular Expression Denial of Service

  Package         braces

  Patched in      >=2.3.1

  Dependency of   markdown2confluence [dev]

  Path            markdown2confluence > webpack > watchpack > chokidar >
                  anymatch > micromatch > braces

  More info       https://npmjs.com/advisories/786


  Low             Regular Expression Denial of Service

  Package         clean-css

  Patched in      >=4.1.11

  Dependency of   markdown2confluence [dev]

  Path            markdown2confluence > jade > clean-css

  More info       https://npmjs.com/advisories/785

Cheers,
Mo

Alternate library available - did you want my changes?

In addition to fixing how links work, I've added a bunch of tests, fixed many conversion problems between markdown and Confluence, automatically run the tests on builds, included a link rewriting facility, and even made it possible to theme the code blocks. The README is now much more useful and there's eslint included to enforce a consistent style. Even the sample program under bin/ can now read from stdin.

You're welcome to adopt my changes. If you adopt all of the features/improvements and all of the tests pass, I'll volunteer to delete my fork of your project. I can say that my updated library works flawlessly with a pretty involved site and your version would be better if you even just adopted the tests and solved for the different use cases.

https://github.com/connected-world-services/markdown2confluence-cws

Images not converted

• Images are not converted to !test.png! (not speaking about images in subdirectories)

Pandoc integration

This is an excellent project and was really useful, have you considered adding it to Pandoc via a custom markdown definition in Lua?

Here is an example: https://github.com/jgm/pandoc/blob/master/data/sample.lua

Though here they reckon it's just XHTML anyway: jgm/pandoc#2155

But it might be worth looking in to.

Nested ordered lists don't convert correctly

This markdown:

1. First parent item
  1. first parent's child
  2. first parent's other child
2. Second parent item

...should render as:

# First parent item
## first parent's child
## first parent's other child
# Second parent item

...but instead renders as:

# First parent item
# # first parent's child
# # first parent's other child
# Second parent item

The extra space between the two #'s causes Confluence to not render as a nested list properly.

Markdown text contains '{text}', convertion will keep '{text}' instead of '\{text\}'

example:

- **【规则】正确填写日志格式化隐私参数标识{public},{private}**

will make

* *【规则】正确填写日志格式化隐私参数标识{public},{private}*

and wiki preview in confluence will be like

Task Items not rendered

• task items are not converted
• we want always more!

horizontal line not rendering on a new line

Probably a simple fix.

Input:

# Hello

--- 

# World

Expecting:

h1. Hello

----

h1. World

Output:

h1. Hello

----h1. World

don't convert if text next to backtick

issue

example :

Lorem Ipsum is simply dummy text of the printing and typesetting industry.
one is 1.
two is 2.
{{Three}}is 3.
@Controller
@Repository
{{@Service}}ddd

Expected :

Lorem Ipsum is simply dummy text of the printing and typesetting industry.
one is 1.
two is 2.
Three is 3.
@Controller
@Repository
@Serviceddd

but result :

Lorem Ipsum is simply dummy text of the printing and typesetting industry.
one is 1.
two is 2.
{{Three}}is 3.
@Controller
@Repository
{{@Service}}ddd

##​ My opinion

I upload image. It is use markup menu in confluence. {{ }} If the text is next to backtick, it won't convert properly.

呈现代码宏出错: 参数'com.atlassian.confluence.ext.code.render.InvalidValueException'的值无效

version ： Confluence 7.12.2

Code spans should escape inner opening curly braces

Markdown input	Expected Confluence output	Actual Confluence output
`{hello} {world}`	{{\{hello} \{world}}}	{{{hello} {world}}}

When the input Markdown contains { in a code span, the text is wrapped in {{ }}, but Confluence also expects the inner { to be escaped with \. This produces a warning when inserted into Confluence:

{{
Unknown macro: {hello}
Unknown macro: {world}
}}

blank cell in table will miss

If I write a markdown table like this:

A	B	C
a	b	c
d		f
I have blankspace between d and f
but if convert into confluence wiki, it is
	A
a	b	c
d		f
The result shows that I miss a cell.

Converting edge cases

Hi. Awesome tool, helped me a lot. I had to do some manual pre-processing to filter out some lines. Thought I share this, I saw that some of them are already posted as issues and filter them out.

1. html links <a> are not converted or dropped. Oftentime used for jumping in the document to other parts.

2. markdown comments are included in the final document. They start with <--

3. When using a code block without any language it should default to none. Otherwise the coloring is for most black, but not for the ones without.