Skip to content

Commit 9b43a37

Browse files
Deployed ec85c62 with MkDocs version: 1.6.1
1 parent 3e79443 commit 9b43a37

File tree

3 files changed

+20
-5
lines changed

3 files changed

+20
-5
lines changed

index.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
<ul class="nav flex-column">
9292
</ul>
9393
</li>
94-
<li class="nav-item" data-bs-level="2"><a href="#result-examples" class="nav-link">Result Examples</a>
94+
<li class="nav-item" data-bs-level="2"><a href="#output-formats" class="nav-link">Output Formats</a>
9595
<ul class="nav flex-column">
9696
</ul>
9797
</li>
@@ -206,8 +206,14 @@ <h2 id="track-manual">Track Manual</h2>
206206
--current path/to/current/report/cpu.txt \
207207
--output-format &quot;detailed&quot;
208208
</code></pre>
209-
<h2 id="result-examples">Result Examples</h2>
210-
<p>Prof's performance comparison provides two output formats to help you understand performance changes at different levels of detail.</p>
209+
<h2 id="output-formats">Output Formats</h2>
210+
<p>Prof's performance comparison provides multiple output formats to help you understand performance changes at different levels of detail and presentation.
211+
<strong>Currently supported formats:</strong></p>
212+
<ul>
213+
<li><strong>Terminal (default)</strong></li>
214+
<li><strong>HTML</strong></li>
215+
<li><strong>JSON</strong></li>
216+
</ul>
211217
<h3 id="summary-format">Summary Format</h3>
212218
<p>The summary format gives you a high-level overview of all performance changes, organized by impact:</p>
213219
<pre><code>==== Performance Tracking Summary ====
@@ -261,6 +267,15 @@ <h3 id="detailed-format">Detailed Format</h3>
261267

262268
Severity: CRITICAL
263269
Recommendation: Critical regression! Immediate investigation required.
270+
</code></pre>
271+
<h3 id="html-json-output">HTML &amp; JSON Output</h3>
272+
<p>In addition to terminal display, Prof can export both <strong>summary</strong> and <strong>detailed</strong> reports in:</p>
273+
<ul>
274+
<li>📄 <strong>HTML</strong>: shareable and human-friendly</li>
275+
<li>🧩 <strong>JSON</strong>: structured format for programmatic use or further integration</li>
276+
</ul>
277+
<pre><code class="language-sh">--output-format summary-html
278+
--output-format detailed-json
264279
</code></pre></div>
265280
</div>
266281
</div>
@@ -343,5 +358,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
343358

344359
<!--
345360
MkDocs version : 1.6.1
346-
Build Date UTC : 2025-07-28 23:38:26.364244+00:00
361+
Build Date UTC : 2025-07-29 16:07:47.194040+00:00
347362
-->

0 commit comments

Comments
 (0)