Comment Format Support

About 1 min...

You can add different contents to comment, including extended Markdown syntax and HTML tags.

Format Support

We support the full CommonMark (standard Markdown syntax), along with the following extensions:

  • GFM style table
  • GFM style strike through
  • Subscript and superscript
  • Emoji
  • Code block highlighting
  • TEX formula

GFM

Github Flavored Markdown

Meanwhile, you can freely embed any HTML content without triggering the protection mechanism.

Limited Preview Support

In order to control the size of the client, we only place a small Markdown parser in the official client @waline/client, which causes many grammars to not display correctly in the preview panel (they can be correctly rendered in the comment area).

This includes the following restrictions:

  • Standard emoji syntax (eg 🎉:tada:) does not render correctly

  • The upper and lower subscripts (eg: H~2~O, x^2^) cannot be rendered correctly

  • Tex syntax, i.e. math formulas (eg: $a = 1$) cannot be rendered by default.

    When using the official client, you can customize the Tex rendering in preview by setting the texRenderer option, see Cookbook → Use a custom TEX renderer.

  • Under the default highlighter, code blocks will be highlighted with random colors with specific delimiters.

    When using the official client, you can customize the code highlighting when previewing by setting the highlighter option, see Cookbook → Custom Code Highlighting.

More

Principle

  1. Considering package size, the client uses marked for rendering and uses a < 1kb highlighter for highlighting by default, and does not include a Tex renderer, resulting in the above limitations.

  2. When a user submits a comment, the client embeds a custom Emoji image and sends the original comment to the server.

  3. The server receives the original text, uses markdown-it to render markdown correctly with relevant plug-ins, uses prismjs to highlight code blocks according to the language, and performs Tex rendering according to user settings, and finally performs XSS processing .

  4. After the processing is completed, the server will store the correct rendering content and return it to the client when needed to ensure the normal display of the comment area.

TIPS: The comment area is only for demo. If you have any questions, please go to Github Discussion to ask.
What do you think?
  • 0
  • 0
  • 0
  • 0
  • 0
  • 0
Comments
  • Latest
  • Oldest
  • Hottest
Powered by Waline v2.14.7