Skip to content

About

Official website for Dotfiles (dotfiles.io): chezmoi-managed, cross-platform dotfiles for macOS, Linux, WSL, and PowerShell with Neovim, Zsh, Tmux, Git, and SSH hardening.

Topics

Resources

Stars

26 stars

Watchers

1 watching

Forks

Repository files navigation

dotfiles.io

The source of dotfiles.io, the product site for .dotfiles: chezmoi-managed dotfiles for macOS, Linux, WSL and PowerShell. The full documentation lives at doc.dotfiles.io, built from the main repository's docs/.

Build

The site is built with ssg 0.0.63 or later and the Lucid theme in _layouts/, the same theme as doc.dotfiles.io (its source is docs/site/themes/lucid in the dotfiles repository; only header.html and index.html differ).

cargo install ssg --locked   # or put an ssg release binary on PATH
make build                   # into _site/, with link and origin checks
make serve                   # build, then http://127.0.0.1:8000/
make validate                # build, then html-validate (needs npx)

scripts/build-site.py merges the site-wide fields into each page in content/, runs ssg, and fails if an internal link is broken or a page references a third-party origin. It also serves the not-found page as /404.html (noindex, out of the feeds), writes the one /sitemap.xml, and fails if a sitemap, feed or hreflang URL is not a page in the build.

Deploy

.github/workflows/pages.yml builds and validates every pull request and deploys main to GitHub Pages with a pinned, checksum-verified ssg.

Layout

Path Contents
content/ Page sources: home, privacy, accessibility, 404
_layouts/ The Lucid theme shared with doc.dotfiles.io, plus this site's header and home layout
scripts/build-site.py Build and checks (Python standard library only)
CNAME The custom domain, dotfiles.io

Licence

Apache-2.0 OR MIT, at your choice.

About

Official website for Dotfiles (dotfiles.io): chezmoi-managed, cross-platform dotfiles for macOS, Linux, WSL, and PowerShell with Neovim, Zsh, Tmux, Git, and SSH hardening.

Topics

Resources

Stars

26 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages