Class MarkdownUtils

java.lang.Object

ubic.gemma.core.util.MarkdownUtils

public class MarkdownUtils
extends Object

Utilities for handling Markdown text.

Author:

poirigui

Constructor Summary

Constructors

Constructor	Description
MarkdownUtils()

Method Summary

Modifier and Type	Method	Description
static String	escapeMarkdown(String text)	Escape special Markdown characters in a string.
static String	formatMarkdownCodeSpan(String text)	Format a string as a Markdown code span.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MarkdownUtils

public MarkdownUtils()

Method Details

escapeMarkdown

@Nullable
public static String escapeMarkdown(@Nullable
 String text)

Escape special Markdown characters in a string.

This is aiming at escaping [Common Mark](https://spec.commonmark.org/) markdown.

formatMarkdownCodeSpan

@Nullable
public static String formatMarkdownCodeSpan(@Nullable
 String text)

Format a string as a Markdown code span.

This takes care of escaping backticks by surrounding the text with double backticks (or more).