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
4 changes: 2 additions & 2 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3"
gem "just-the-docs"
gem "jekyll", "~> 4.4.1"
gem "just-the-docs" , "~> 0.11.0"
gem "webrick"
gem "jekyll-seo-tag"
gem "listen"
10 changes: 9 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ url: "https://reugn.github.io"
# Theme
theme: just-the-docs

# Sass (silence deprecation warnings from theme)
sass:
quiet_deps: true
silence_deprecations:
- import
- global-builtin
- color-functions

# Color scheme
color_scheme: dark
color_scheme: light

# Aux links (top right)
aux_links:
Expand Down
54 changes: 54 additions & 0 deletions docs/_includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,56 @@
<link rel="icon" href="{{ '/assets/images/favicon.svg' | relative_url }}" type="image/svg+xml">

<!-- Determine theme before loading stylesheets -->
<script>
var jtdTheme = localStorage.getItem('jtd-theme') || 'light';
document.documentElement.setAttribute('data-theme', jtdTheme);
</script>

<!-- Theme stylesheets - disabled state set dynamically -->
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-light.css' | relative_url }}" id="jtd-light">
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-dark.css' | relative_url }}" id="jtd-dark">
<script>
(function() {
var isDark = jtdTheme === 'dark';
document.getElementById('jtd-light').disabled = isDark;
document.getElementById('jtd-dark').disabled = !isDark;
})();

function toggleTheme() {
var current = document.documentElement.getAttribute('data-theme') || 'light';
var newTheme = current === 'light' ? 'dark' : 'light';

document.documentElement.setAttribute('data-theme', newTheme);

var lightCss = document.getElementById('jtd-light');
var darkCss = document.getElementById('jtd-dark');
var isDark = newTheme === 'dark';
if (lightCss) lightCss.disabled = isDark;
if (darkCss) darkCss.disabled = !isDark;

try {
localStorage.setItem('jtd-theme', newTheme);
} catch (e) {}
}
</script>

<style>
.theme-toggle {
background: none;
border: none;
cursor: pointer;
padding: 4px 8px;
font-size: 1.1rem;
color: var(--link-color);
vertical-align: middle;
margin-right: 0.5rem;
}
.theme-toggle:hover {
opacity: 0.7;
}
/* Show correct icon based on theme */
.icon-sun { display: none; }
.icon-moon { display: inline; }
[data-theme="dark"] .icon-sun { display: inline; }
[data-theme="dark"] .icon-moon { display: none; }
</style>
3 changes: 3 additions & 0 deletions docs/_includes/header_custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<button class="theme-toggle" onclick="toggleTheme()" title="Toggle theme">
<span class="icon-moon">🌑</span><span class="icon-sun">☀️</span>
</button>
4 changes: 4 additions & 0 deletions docs/assets/css/just-the-docs-dark.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
@import "just-the-docs";
:root {
--color-scheme: dark;
}
1 change: 1 addition & 0 deletions docs/assets/css/just-the-docs-light.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import "css/just-the-docs.scss";
2 changes: 1 addition & 1 deletion docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Or create `.github-ci.yaml` manually in your repository root.

```yaml
run:
timeout: 5m # timeout for GitHub API operations
timeout: 5m # maximum duration for command execution
issues-exit-code: 1 # exit code when issues are found

linters:
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ run:

### timeout

Maximum time allowed for GitHub API operations.
Maximum time allowed for command execution.

| Value | Description |
|-------|-------------|
Expand All @@ -28,11 +28,11 @@ Maximum time allowed for GitHub API operations.
| `5m` | 5 minutes (default) |
| `1h` | 1 hour |

This is useful for CI/CD environments with strict time limits. If the timeout is reached, the command will fail.
When the timeout is reached, the command is cancelled.

```yaml
run:
timeout: 2m # Fail if API calls take longer than 2 minutes
timeout: 2m # Maximum duration for the entire command execution
```

### issues-exit-code
Expand Down
Loading