Skip to content

build: initialize static pages website for dots #1

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

Closed
CtrlUserKnown wants to merge 1 commit into from
Closed

build: initialize static pages website for dots #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Empty file added .nojekyll
View file
Open in desktop
Empty file.
34 changes: 34 additions & 0 deletions PROMPT_SITE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Dots website

## requirements

I want this site to be easy to use and understand. The paragraphs should be concise but not unclear. there should be no m dashes will be accepted in the writting, it should sound like I wrote this. This website should have the following pages:

- landing/home page
- about page
- docs page (in-page links)
- changelog page
- link to github page

get the data you need from https://github.com/CtrlUserKnown/dots. the docs will be from https://github.com/CtrlUserKnown/dots/wiki.

### requirements.changelog

The changelog page should be dynamic. Being able to pull changelog from the github & update based on that.


### requirements.backend

The site should account for different plateforms like safari, firefox, other browsers, mobile plateforms. The site data should be structure and have clearly defined data. alt data, picture sizes, & desciptions. It should make sure the github does not force Jekyll. there should be the following files with the proper data in it:

- robots.txt
- site.webmanifest
- sitemap.xml

## theme

There site should use the noir-cat theme from the config. use the github repo to get the theme from ghostty config.

# layout/design

The layout should look clean & must be responcive. The site layout/design should consider mobile layouts.
188 changes: 188 additions & 0 deletions about.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>About — dots</title>
<meta name="description" content="What dots is, how it works, and why it exists.">
<meta name="author" content="CtrlUserKnown">

<link rel="icon" href="img/svg/dots_icon_color.svg" type="image/svg+xml">
<link rel="alternate icon" href="img/svg/dots_favicons_color.svg">
<link rel="apple-touch-icon" href="img/svg/dots_favicons_color.svg">
<link rel="manifest" href="site.webmanifest">
<meta name="theme-color" content="#1a1a1a">

<meta property="og:title" content="About — dots">
<meta property="og:description" content="What dots is, how it works, and why it exists.">
<meta property="og:type" content="website">
<meta property="og:url" content="https://ctrluserknown.github.io/dots/about.html">

<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">

<link rel="stylesheet" href="css/style.css">
</head>
<body>

<nav class="nav" role="navigation" aria-label="Main navigation">
<div class="nav__inner">
<a href="index.html" class="nav__logo" aria-label="dots home">
<img src="img/svg/dots_logo_alt_color.svg" alt="dots" width="80" height="26">
</a>
<button class="nav__toggle" aria-label="Toggle menu" aria-expanded="false" aria-controls="nav-menu">
<span></span>
<span></span>
<span></span>
</button>
<div class="nav__menu" id="nav-menu">
<ul class="nav__links" role="list">
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About</a></li>
<li><a href="docs.html">Docs</a></li>
<li><a href="changelog.html">Changelog</a></li>
</ul>
<a href="https://github.com/CtrlUserKnown/dots" class="nav__github" target="_blank" rel="noopener noreferrer" aria-label="View on GitHub">
<svg width="15" height="15" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true">
<path d="M12 2C6.477 2 2 6.477 2 12c0 4.419 2.865 8.166 6.839 9.489.5.09.682-.218.682-.484 0-.236-.009-.866-.013-1.7-2.782.602-3.369-1.34-3.369-1.34-.455-1.157-1.11-1.465-1.11-1.465-.908-.62.069-.608.069-.608 1.003.07 1.531 1.03 1.531 1.03.892 1.529 2.341 1.088 2.91.833.091-.647.349-1.086.635-1.337-2.22-.251-4.555-1.111-4.555-4.943 0-1.091.39-1.984 1.029-2.683-.103-.252-.446-1.27.098-2.647 0 0 .84-.269 2.75 1.026A9.578 9.578 0 0 1 12 6.836c.85.004 1.705.114 2.504.336 1.909-1.294 2.747-1.026 2.747-1.026.546 1.377.203 2.394.1 2.647.64.699 1.028 1.592 1.028 2.683 0 3.842-2.339 4.687-4.566 4.935.359.309.678.919.678 1.852 0 1.336-.012 2.415-.012 2.741 0 .269.18.579.688.481C19.138 20.163 22 16.418 22 12c0-5.523-4.477-10-10-10z"/>
</svg>
GitHub
</a>
</div>
</div>
</nav>

<main>
<div class="container">
<header class="page-header">
<h1>About</h1>
<p class="lead">What dots is and why it exists.</p>
</header>

<div class="about-grid">
<div class="about-main">
<p>
Dots started as a Zsh config and kept growing. At some point it became easier to put everything in one place and automate the setup instead of running the same install steps on every new machine.
</p>
<p>
The project manages configs for Ghostty, Zsh, bat, fastfetch, and a few other tools. Everything lives in <code>src/</code> organized by tool, and a setup script handles Homebrew, dependencies, and symlinking everything into the right places.
</p>

<h2>The dots command</h2>
<p>
<code>dots</code> is a curses TUI that handles the day-to-day: health checks, theme switching, settings, viewing aliases, and git operations. It replaces a lot of one-off commands that I kept needing to remember. Advanced items like editing configs and adding aliases are unlocked in developer mode.
</p>
<p>
There's also <code>ssm</code>, a TUI for managing SSH sessions. It lets you search, connect, duplicate sessions, and pull dotfiles to remote hosts without switching windows.
</p>

<h2>Design goals</h2>
<p>
Fast installs. Configs that don't break when you switch branches. Tools that talk to each other (bat previews in fzf, zoxide jump in completions, herdr auto-launching on SSH). And an update mechanism that stays out of the way unless there's actually something new.
</p>
<p>
The setup uses per-package install timeouts so one slow dependency doesn't block everything else. Symlinks are conditional based on what's installed so the config stays clean if you skip Ghostty or herdr.
</p>

<h2>Package tiers</h2>
<p>
Dependencies are split into three tiers so you're only prompted for what's relevant to you. Required tools install automatically. Optional and dev packages are prompted during setup and can be installed later via the TUI or CLI flags.
</p>
<p>
The same dependency system works on Homebrew (macOS), DNF (Fedora), and APT (Debian/Ubuntu), so the configs travel further than just Mac.
</p>

<h2>Theme</h2>
<p>
This site uses the <strong>noir-cat</strong> Ghostty theme from the repo. It's a dark theme based on the Catppuccin Mocha palette with a neutral gray background instead of the standard purple-tinted one. The terminal and site share the same color scheme.
</p>
</div>

<aside class="about-aside">
<div class="aside-card">
<h4>Links</h4>
<div class="aside-links">
<a href="https://github.com/CtrlUserKnown/dots" target="_blank" rel="noopener noreferrer">
<svg width="14" height="14" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true">
<path d="M12 2C6.477 2 2 6.477 2 12c0 4.419 2.865 8.166 6.839 9.489.5.09.682-.218.682-.484 0-.236-.009-.866-.013-1.7-2.782.602-3.369-1.34-3.369-1.34-.455-1.157-1.11-1.465-1.11-1.465-.908-.62.069-.608.069-.608 1.003.07 1.531 1.03 1.531 1.03.892 1.529 2.341 1.088 2.91.833.091-.647.349-1.086.635-1.337-2.22-.251-4.555-1.111-4.555-4.943 0-1.091.39-1.984 1.029-2.683-.103-.252-.446-1.27.098-2.647 0 0 .84-.269 2.75 1.026A9.578 9.578 0 0 1 12 6.836c.85.004 1.705.114 2.504.336 1.909-1.294 2.747-1.026 2.747-1.026.546 1.377.203 2.394.1 2.647.64.699 1.028 1.592 1.028 2.683 0 3.842-2.339 4.687-4.566 4.935.359.309.678.919.678 1.852 0 1.336-.012 2.415-.012 2.741 0 .269.18.579.688.481C19.138 20.163 22 16.418 22 12c0-5.523-4.477-10-10-10z"/>
</svg>
GitHub repository
</a>
<a href="docs.html">
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<path d="M14 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V8z"></path>
<polyline points="14 2 14 8 20 8"></polyline>
</svg>
Documentation
</a>
<a href="changelog.html">
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<circle cx="12" cy="12" r="10"></circle>
<polyline points="12 6 12 12 16 14"></polyline>
</svg>
Changelog
</a>
<a href="https://github.com/CtrlUserKnown/Charvim" target="_blank" rel="noopener noreferrer">
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
<path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path>
<polyline points="15 3 21 3 21 9"></polyline>
<line x1="10" y1="14" x2="21" y2="3"></line>
</svg>
Charvim (Neovim config)
</a>
</div>
</div>

<div class="aside-card">
<h4>Current version</h4>
<p style="font-family: 'JetBrains Mono', monospace; font-size: 1.1rem; color: #fff; margin: 0;">v1.5.5</p>
</div>

<div class="aside-card">
<h4>Requirements</h4>
<p style="color: var(--fg-muted); font-size: 0.875rem; margin-bottom: 0.75rem;">macOS 12.0+ (Monterey or newer)</p>
<p style="color: var(--fg-muted); font-size: 0.875rem; margin-bottom: 0.75rem;">Apple Silicon preferred, Intel supported</p>
<p style="color: var(--fg-muted); font-size: 0.875rem; margin: 0;">Zsh (default on macOS 10.15+)</p>
</div>

<div class="aside-card">
<h4>Stack</h4>
<div class="chips">
<span class="stack-chip">Ghostty</span>
<span class="stack-chip">Zsh</span>
<span class="stack-chip">herdr</span>
<span class="stack-chip">fzf</span>
<span class="stack-chip">bat</span>
<span class="stack-chip">eza</span>
<span class="stack-chip">fastfetch</span>
<span class="stack-chip">zoxide</span>
<span class="stack-chip">Python 3</span>
</div>
</div>
</aside>
</div>
</div>
</main>

<footer class="footer" role="contentinfo">
<div class="container">
<div class="footer__inner">
<div class="footer__brand">
<img src="img/svg/dots_icon_color.svg" alt="" aria-hidden="true" width="18" height="18">
<span class="footer__copy">dots by CtrlUserKnown</span>
</div>
<nav class="footer__nav" aria-label="Footer navigation">
<a href="about.html">About</a>
<a href="docs.html">Docs</a>
<a href="changelog.html">Changelog</a>
<a href="https://github.com/CtrlUserKnown/dots" target="_blank" rel="noopener noreferrer">GitHub</a>
</nav>
</div>
</div>
</footer>

<script src="js/nav.js"></script>

</body>
</html>
67 changes: 0 additions & 67 deletions assets/packages.fedora
View file
Open in desktop

This file was deleted.

46 changes: 0 additions & 46 deletions assets/packages.personal.example
View file
Open in desktop

This file was deleted.

Loading
Loading