Non-code info blocks

Hello!

Before I go and write my own extension, I want to validate if there is already a way to extend something existing to create non-code info blocks.

Currently info blocks are something like this:

~~~info
my code
~~~

which converts into

<pre><code class="language-info"> 
my code
</code>
</pre>

Where as I am looking to make something that will do:

<p class="my-info">
my code
</p>

The intention is to standardize how we do alerts, warnings and other non-code call-outs within documentation.

Many thanks for any advice on what’s the right path for this.

Cheers, Olya

[vsch]

@olyas, there is not an extension for this but you can easily create an extension with a custom fenced code renderer that renders only info tagged ones and passes the rest to the core renderer.

You can use PegdownCustomLinkResolverOptions as an example but change the rendering part to:

@Override
public Set<NodeRenderingHandler<?>> getNodeRenderingHandlers() {
    HashSet<NodeRenderingHandler<?>> set = new HashSet<NodeRenderingHandler<?>>();
    set.add(new NodeRenderingHandler<FencedCodeBlock>(FencedCodeBlock.class, new CustomNodeRenderer<FencedCodeBlock>() {
        @Override
        public void render(FencedCodeBlock node, NodeRendererContext context, HtmlWriter html) {
            // test the node to see if it needs overriding
            if (node.getInfo().equals("info")) {
                html.attr("class", "my-info").withAttr().tag("p").line();
                html.text(node.getContentChars().normalizeEOL());
                html.closeTag("p").line();
            } else {
                context.delegateRender();
            }
        }
    }));
    return set;
}

Only use what you need from the sample. It is made for pegdown migration sample so you don’t need any of the pegdown related stuff.

[olyas]

Thank you! With some more clean up and great help from a coworker as well as your comment we got it to work. It’s delightful 😃