Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/_sass/_code.scss
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@
}

.code-panel--before .code-panel__header {
background: rgba($accent-red, 0.06);
background: rgba($accent-red, 0.08);
color: $accent-red;
}

.code-panel--after .code-panel__header {
background: rgba($primary, 0.06);
color: $primary;
background: rgba($primary, 0.10);
color: $primary-dark;
}

.code-panel__body {
Expand Down
2 changes: 1 addition & 1 deletion docs/_sass/_hero.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
justify-content: center;
text-align: center;
overflow: hidden;
background: linear-gradient(135deg, #f0fafa 0%, #e0f4f4 30%, #f5f9fa 60%, #e8f6f6 100%);
background: linear-gradient(135deg, #f2f6f7 0%, #e6eff1 30%, #f5f7f8 60%, #eaf0f2 100%);
padding-top: var(--navbar-height);
}

Expand Down
14 changes: 7 additions & 7 deletions docs/_sass/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ $primary-glow: rgba(70, 191, 198, 0.25);

// Light mode
$light-bg: #ffffff;
$light-surface: #f5fafa;
$light-surface-alt: #eaf5f5;
$light-surface: #f4f7f8;
$light-surface-alt: #e8eef0;
$light-text: #1a2b3c;
$light-text-muted: #5a6b7c;
$light-border: #d4e8e8;
$light-code-bg: #f0f6f6;
$light-code-border: #d4e8e8;
$light-text-muted: #4d5f6f;
$light-border: #c8d5d9;
$light-code-bg: #f3f5f7;
$light-code-border: #c8d5d9;
$light-card-bg: #ffffff;
$light-card-shadow: rgba(70, 191, 198, 0.08);
$light-card-shadow: rgba(70, 191, 198, 0.12);

// Dark mode
$dark-bg: #0d1520;
Expand Down
16 changes: 16 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,22 @@ dependencies {
</plugin>
```

### Set Up Logging Output

Timer Ninja uses **SLF4J** for logging. Depending on your project, choose one of the following:

**Spring Boot projects** — no extra setup needed. Spring Boot ships with Logback, so Timer Ninja output will appear in your logs automatically.

**Non-Spring projects with an SLF4J provider** — if you already have Logback, Log4j2, or another SLF4J-compatible logging framework, you're good to go. Just make sure the log level for `io.github.thanglequoc.timerninja.TimerNinjaUtil` is at least `INFO`.

**No logging framework?** — enable System.out output at application startup:

```java
TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true);
```

This prints trace output directly to the console — useful for quick testing or simple console applications.

---

## Annotation-based Tracking
Expand Down
5 changes: 3 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<span class="badge">Open Source &middot; Java Library</span>
</div>
<h1 class="hero__title animate-fade-up">
Measure <span class="text-gradient">Java Method Execution Time</span><br>with a Single Annotation
Measure <span class="text-gradient">Java Code Execution Time</span><br>with a Single Annotation
</h1>
<p class="hero__subtitle animate-fade-up">
Track code execution time in Java effortlessly. Get a full call hierarchy with timing &amp; arguments — no heavy tracing frameworks required.
Expand Down Expand Up @@ -302,6 +302,7 @@ <h3>Annotate Your Methods</h3>
<div class="step-card__content">
<h3>Run &amp; See the Trace &#128007;</h3>
<p>Execute your code — Timer Ninja automatically logs the execution trace.</p>
<p style="font-size: 0.9rem; opacity: 0.85;"><strong>Note:</strong> Timer Ninja uses SLF4J. Spring Boot projects work out of the box. For other projects without a logging provider, enable console output with <code>TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true)</code>.</p>
<pre><code>public void processPayment(User user, int amount) - 770 ms
|-- public boolean changeAmount(User user, int amount) - 306 ms
|-- public void notify(User user) - 258 ms</code></pre>
Expand All @@ -317,7 +318,7 @@ <h3>Run &amp; See the Trace &#128007;</h3>
<div class="hero__mascot animate-fade-up" style="width: 100px; height: 100px;">
<img src="{{ '/assets/images/mascot.png' | relative_url }}" alt="Timer Ninja mascot">
</div>
<h2 class="animate-fade-up">Ready to <span class="text-gradient">Track Like a Ninja</span>?</h2>
<h2 class="animate-fade-up">Ready to <span class="text-gradient">track them all?</span>?</h2>
<p class="animate-fade-up" style="max-width: 560px; margin: 0 auto 2rem; font-size: 1.1rem;">
Block tracking, custom thresholds, constructor tracking, and more — explore all features in the docs and start measuring Java method execution time the smart way.
</p>
Expand Down
16 changes: 16 additions & 0 deletions wiki/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,22 @@ dependencies {
</plugin>
```

### Set Up Logging Output

Timer Ninja uses **SLF4J** for logging. Depending on your project, choose one of the following:

**Spring Boot projects** — no extra setup needed. Spring Boot ships with Logback, so Timer Ninja output will appear in your logs automatically.

**Non-Spring projects with an SLF4J provider** — if you already have Logback, Log4j2, or another SLF4J-compatible logging framework, you're good to go. Just make sure the log level for `io.github.thanglequoc.timerninja.TimerNinjaUtil` is at least `INFO`.

**No logging framework?** — enable System.out output at application startup:

```java
TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true);
```

This prints trace output directly to the console — useful for quick testing or simple console applications.

---

## Annotation-based Tracking
Expand Down
Loading