Skip to content

docs update #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Dishpit merged 3 commits into from
May 31, 2025
Merged

docs update #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c68b7e9
initial consolidation
Dishpit May 31, 2025
3e77d74
sidebar condense, better interactivity
Dishpit May 31, 2025
d16be17
Merge pull request #17 from SimuCorps/docs/consolidation
Dishpit May 31, 2025
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
5 changes: 2 additions & 3 deletions docs/changeblog.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
</div>
<ul class="nav-menu">
<li><a href="index.html" class="nav-link">Home</a></li>
<li><a href="getting-started.html" class="nav-link">Getting Started</a></li>
<li><a href="language-guide.html" class="nav-link">Language Guide</a></li>
<li><a href="docs.html" class="nav-link">Docs</a></li>
<li><a href="examples.html" class="nav-link">Examples</a></li>
<li><a href="changeblog.html" class="nav-link active">Changeblog</a></li>
<li><a href="https://github.com/SimuCorps/Gem" class="nav-link" target="_blank">GitHub</a></li>
Expand Down Expand Up @@ -402,7 +401,7 @@ <h2>What's Next?</h2>
</div>
<div class="footer-links">
<a href="https://github.com/SimuCorps/Gem" target="_blank">GitHub</a>
<a href="getting-started.html">Documentation</a>
<a href="docs.html">Documentation</a>
<a href="changeblog.html">Changeblog</a>
</div>
</div>
Expand Down
149 changes: 142 additions & 7 deletions docs/docs.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,27 @@
border-radius: var(--border-radius);
padding: 1.5rem;
border: 1px solid var(--border-color);
max-height: calc(100vh - 8rem);
overflow-y: auto;
scrollbar-width: thin;
scrollbar-color: var(--border-color) transparent;
}

.docs-sidebar::-webkit-scrollbar {
width: 6px;
}

.docs-sidebar::-webkit-scrollbar-track {
background: transparent;
}

.docs-sidebar::-webkit-scrollbar-thumb {
background: var(--border-color);
border-radius: 3px;
}

.docs-sidebar::-webkit-scrollbar-thumb:hover {
background: var(--text-secondary);
}

.docs-nav h3 {
Expand All @@ -31,31 +52,133 @@
border-bottom: 1px solid var(--border-color);
}

.docs-nav ul {
/* Navigation sections */
.nav-section {
margin-bottom: 0.75rem;
}

.nav-section-toggle {
width: 100%;
background: none;
border: none;
padding: 0.75rem;
text-align: left;
font-size: 0.9rem;
font-weight: 600;
color: var(--text-primary);
cursor: pointer;
border-radius: 0.375rem;
transition: all 0.2s ease;
display: flex;
align-items: center;
gap: 0.5rem;
}

.nav-section-toggle:hover {
background: var(--bg-tertiary);
}

.nav-section-toggle.active {
background: var(--primary-color);
color: white;
}

.toggle-icon {
font-size: 0.75rem;
transition: transform 0.2s ease;
width: 12px;
text-align: center;
}

.nav-section-toggle.active .toggle-icon {
transform: rotate(0deg);
}

.nav-section-content {
list-style: none;
margin: 0;
padding: 0;
overflow: hidden;
transition: max-height 0.3s ease, opacity 0.2s ease;
max-height: 500px;
opacity: 1;
}

.docs-nav li {
margin-bottom: 0.5rem;
.nav-section-content.collapsed {
max-height: 0;
opacity: 0;
}

.nav-section-content li {
margin-bottom: 0.25rem;
}

.docs-nav a {
.nav-section-content a {
color: var(--text-secondary);
text-decoration: none;
font-size: 0.9rem;
padding: 0.5rem 0.75rem;
font-size: 0.85rem;
padding: 0.5rem 0.75rem 0.5rem 1.5rem;
border-radius: 0.25rem;
display: block;
transition: all 0.2s ease;
position: relative;
}

.docs-nav a:hover {
.nav-section-content a:before {
content: '';
position: absolute;
left: 0.75rem;
top: 50%;
transform: translateY(-50%);
width: 4px;
height: 4px;
background: var(--text-secondary);
border-radius: 50%;
opacity: 0.5;
}

.nav-section-content a:hover {
background: var(--primary-color);
color: white;
}

.nav-section-content a:hover:before {
background: white;
opacity: 1;
}

.nav-section-content a.active {
background: var(--accent-color);
color: white;
font-weight: 500;
}

.nav-section-content a.active:before {
background: white;
opacity: 1;
}

/* Copy button for code blocks */
.copy-button {
position: absolute;
top: 0.75rem;
right: 0.75rem;
background: rgba(255, 255, 255, 0.1);
border: 1px solid rgba(255, 255, 255, 0.2);
border-radius: 0.25rem;
padding: 0.5rem;
color: #e2e8f0;
cursor: pointer;
font-size: 0.875rem;
transition: all 0.2s ease;
z-index: 10;
}

.copy-button:hover {
background: rgba(255, 255, 255, 0.2);
border-color: rgba(255, 255, 255, 0.3);
}

/* Content */
.docs-content {
max-width: none;
Expand Down Expand Up @@ -280,6 +403,18 @@ kbd {
position: static;
order: 2;
margin-top: 2rem;
max-height: none;
overflow-y: visible;
}

.nav-section-toggle {
padding: 1rem;
font-size: 1rem;
}

.nav-section-content a {
padding: 0.75rem 1rem 0.75rem 2rem;
font-size: 0.9rem;
}

.docs-content {
Expand Down
Loading