Package com.jcabi.github

Interface Markdown

All Known Implementing Classes:
MkMarkdown
@Immutable public interface Markdown
Markdown API.
Since:
0.6
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    GitHub
    github()
    Get its owner.
    String
    raw(String text)
    Raw rendering.
    String
    render(jakarta.json.JsonObject json)
    Render.

  • Method Details

    • github

      GitHub github()
      Get its owner.
      Returns:
      GitHub

    • render

      String render(jakarta.json.JsonObject json) throws IOException
      Render.
      Parameters:
      json - JSON parameters
      Returns:
      HTML
      Throws:
      IOException - If it fails due to I/O problem

    • raw

      String raw(String text) throws IOException
      Raw rendering.
      Parameters:
      text - Text in Markdown format
      Returns:
      HTML
      Throws:
      IOException - If it fails due to I/O problem