LIVE MARKDOWN DOCUMENTATION FOR APACHE JMETER
README Config
Embed Markdown documentation directly inside JMeter
README Config adds a live Markdown documentation node to any JMeter test plan. Keep your context, runbooks, and notes right alongside the test elements they describe, with zero performance impact.
Documentation Redefined
Keep your test plan documentation where it belongs: inside your test plan.
Live Markdown Preview
Write in the editor tab and see a live GitHub-style preview instantly in the next tab.
GFM Support
Full support for GitHub Flavored Markdown including tables, task lists, and strikethrough.
JMeter Deep-links
Create clickable links that navigate and scroll to specific nodes in your JMeter test plan tree.
Zero Perf Impact
The element is always disabled during test runs, consuming no threads and having zero impact on metrics.
External Links
Clickable hyperlinks open directly in your system browser for easy access to external docs.
Theme Aware
The UI automatically adapts to your JMeter theme for a consistent and integrated experience.
Installation
Get README Config up and running in minutes.
Plugins Manager (Recommended)
Open JMeter → Options → Plugins Manager → Available Plugins, search "README Config", select it, then Apply Changes and Restart JMeter.
# JMeter → Options → Plugins Manager → Available Plugins # Search "README Config" → Apply Changes and Restart JMeter
Plugins Manager CLI
Headless and CI-friendly install via the Plugins Manager command line.
# Linux / macOS bin/PluginsManagerCMD.sh install readme-config-element # Windows bin\PluginsManagerCMD.bat install readme-config-element
Manual JAR Install
Download the latest JAR from the GitHub Releases page, copy it into JMeter's lib/ext directory, and restart JMeter.
# Download from https://github.com/QAInsights/jmeter-readme-config/releases cp <downloaded>.jar $JMETER_HOME/lib/ext/ $JMETER_HOME/bin/jmeter
Add Element
Right-click any node → Add → Config Element → README Config Element.
❓ FAQ
Frequently Asked Questions
Can I add documentation inside a JMeter test plan?
Yes. README Config adds a Markdown documentation node to any JMeter test plan. Write notes, runbooks, and context next to the elements they describe, with a live GitHub-style preview and clickable deep-links to test plan nodes.
Does README Config affect test performance?
No. The element is always disabled during test runs, so it consumes no threads and has zero impact on metrics. It is purely a documentation node.
Is README Config free?
Yes, always. README Config is free and open source under the MIT license, available on GitHub and via the JMeter Plugins Manager (plugin ID: readme-config-element).
GitHub Repository
Explore the source, report issues, and contribute.
QAInsights/readme-config
Embed Markdown documentation directly inside JMeter
Connect
Follow QAInsights for updates, tutorials, and community events.