You are not logged in. Click here to log in.

codebeamer Application Lifecycle Management (ALM)

Search In Project

Search inClear

Tags:  Wiki
IMPORTANT! The information on this page is unverified and unsupported. Always double-check the accuracy of the solutions provided. Evaluate and test the impact on any environments!

Wiki - Does Codebeamer Support Markdown?

Description

  • Is there a way to use Markdown in the Codebeamer editor?
  • Is it possible to automatically import Markdown into Codebeamer?

Observed on

  • Codebeamer 22.10-LTS (GINA)

Solution

At current state, the Codebeamer editor does not support Markdown parsing. The current Codebeamer Wiki Markup is a syntax forked from Apache JSPWiki, and adapted over the years to be able to work with specific Codebeamer scenarios.

For the actual and valid syntax rules, see Wiki Markup and Plugins.


A possible approach would be to use third-party solutions, however, the Support Team may not assist with customization topics.

The below scenarios are neither endorsed nor tested.

Having in mind that the current Codebeamer Markup and JSPWiki rules are not 100% overlapping,

  • Integrate this external plugin: https://jspwiki-wiki.apache.org/Wiki.jsp?page=Markdown%20Support
  • Or, look into this repository: https://github.com/juanpablo-santos/jspwiki-markdown
  • Alternatively, convert the Markdown to raw HTML (an example: https://markdowntohtml.com/) and add it to Codebeamer through the HTML plugin.
    For example:
    [{Html
    
    <h1 id="sample-markdown">Sample Markdown</h1>
    <p>This is some basic, sample markdown.</p>
    <h2 id="second-heading">Second Heading</h2>
    <ul>
    <li>Unordered lists, and:<ol>
    <li>One</li>
    <li>Two</li>
    <li>Three</li>
    </ol>
    </li>
    <li>More</li>
    </ul>
    <blockquote>
    <p>Blockquote</p>
    </blockquote>
    <p>And <strong>bold</strong>, <em>italics</em>, and even <em>italics and later <strong>bold</strong></em>. Even <del>strikethrough</del>. <a href="https://markdowntohtml.com">A link</a> to somewhere.</p>
    <p>And code highlighting:</p>
    <pre><code class="lang-js"><span class="hljs-keyword">var</span> foo = <span class="hljs-string">'bar'</span>;
    
    <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">baz</span><span class="hljs-params">(s)</span> </span>{
       <span class="hljs-keyword">return</span> foo + <span class="hljs-string">':'</span> + s;
    }
    </code></pre>
    <p>Or inline code like <code>var foo = &#39;bar&#39;;</code>.</p>
    <p>Or an image of bears</p>
    <p><img src="http://placebear.com/200/200" alt="bears"></p>
    <p>The end ...</p>
    }]


For any other Support options, questions, or inputs, visit: https://intland.com/technical-support/