icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Custom Viz - Markdown Renderer
SHA256 checksum (custom-viz-markdown-renderer_103.tgz) 347918de5dee4ba717d10010b56d88f6c9b9539f34e2c3f9ea8e58796b62ea66 SHA256 checksum (custom-viz-markdown-renderer_102.tgz) 733acea19ed81ac0c310d97ae19f99109e9b4d6b4657a7b300af34249863aa31
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

Custom Viz - Markdown Renderer

Admins: Please read about Splunk Enterprise 8.0 and the Python 2.7 end-of-life changes and impact on apps and upgradeshere.
The Markdown Visualization allows you to specify a Markdown (md) file to render in the browser as HTML.

Splunk Visualization - markdown

    The Markdown Visualization allows you to specify a Markdown (md) or AsciiDoc (adoc) file to render in the browser as HTML.
    Once configured, you can place a `markdown_style.css` file in the `$APP_HOME/appserver/static` folder of the app the 
    visualization is configured to use. The starting class is `markdown`. A sample has been provided.


The Markdown Visualization has a few options. The options are displayed like this:

  1. Configuration Option Name
    1. Valid Setting Options
    2. Description


  1. Dialect
    1. Maruku, Gruber, ASCIIDoctor
    2. Maruku and Gruber are "Markdown" dialects. Choose ASCIIDoctor if your source is in adoc format.
  2. Location
    1. Local File - Put the markdown source in the appserver/static folder of an app.
    2. Panel HTML - Put the markdown source in a panel on the dashboard as the visualization.
    3. Inline Search - Put the markdown source directly in a search.

Local File

  1. App Name
    1. <string>
    2. This is the name of the app where the File resides.
    3. Also used to pin point the markdown_style.css file to apply CSS style to the Markdown.
  2. Path
    1. <string>
    2. This is the extra path needed to find the file. There should be no leading or following slashes. This path is RELATIVE to $APP_HOME/appserver/static.
  3. File Name
    1. <string>
    2. This is the name of markdown file. No extension needs to be put here, but the file needs to end with either md or adoc on the server.

Panel HTML

  1. HTML ID
    1. This is the HTML id attribute of the element containing the Markdown Source.
    2. The element should be the first root element of the &lt;row&gt;&lt;panel&gt;&lt;html&gt; source.
    3. Multiple Elements are supported. Separate with comma ,.

Inline Search

  1. Search Field
    1. Dictates which field in the result set contains the markdown source.
    2. Multiple rows will be concatenated.


  1. JavasScript Logging
    1. yes, no
    2. This controls if debug logging should be enabled for the view.

Example Search

  1. | makeresults
  2. | makeresults | eval markdown = "## Heading 1"


Please ask a question on Answers. Tag it with "aplura_viz" to get noticed.
Support URL: answers.splunk.com

Third-party software

The Markdown Visualization uses asciidoctor.js and markdown.js.


Report Acceleration: None
Data Model Acceleration: None
Summary Indexing: None

Event Generator

The Markdown Visualization does not have an event generator.

Release Notes

Version 1.0.3
Dec. 2, 2019

Fixed dashboard, verify versions.

Version 1.0.2
Oct. 10, 2017

Updated to perform AsciiDoc rendering in addition to Markdown.
Allows for Inline Search, Local File, and HTML Panel markdown sources.


Subscribe Share

AppInspect Tooling

Splunk AppInspect evaluates Splunk apps against a set of Splunk-defined criteria to assess the validity and security of an app package and components.

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
© 2005-2020 Splunk Inc. All rights reserved.
Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and registered trademarks of Splunk Inc. in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.