Package org.apache.juneau.console.views.markdown

package org.apache.juneau.console.views.markdown

An optional markdown-to-HTML rendering story for the views/console toolkit.

The framework itself renders data tables (juneau-console-views) and chrome (juneau-console); neither has any concept of a rendered document. This optional module fills that gap with a single, library-neutral extension point — MarkdownRenderer — plus a shipped default (CommonmarkMarkdownRenderer) that wraps commonmark-java with the GFM tables extension enabled. Because it is a separate module, consumers that do not need markdown pay nothing for it.

The rendered HTML is meant to be dropped inside a .jc-prose container so it inherits the console's prose typography. Wiring the rendered output into a Tab/Subtab panel's content property is a deferred follow-on integration point, not part of this module.

See Also:

• MarkdownRenderer
• CommonmarkMarkdownRenderer
• commonmark-java

Since:

10.0.0

Related Packages

Package	Description
org.apache.juneau.console.views	A typed, declarative "rich DataTables view" toolkit that serializes to the frozen VIEW_META JSON wire contract consumed by the first-party client runtime.

Class	Description
CommonmarkMarkdownRenderer	The default MarkdownRenderer implementation: a thin wrapper around commonmark-java with the GFM tables extension enabled, HTML-escaped raw markup, and URL allowlisting on <a href> / <img src>.
MarkdownRenderer	A pluggable markdown-to-HTML renderer: hand it a markdown string, get back an HTML fragment.