Forktocat

dotfiles.github.io

Your unofficial guide to dotfiles on GitHub.

GitHub ❤ ~/

Why would I want my dotfiles on GitHub?

Get started with a bootstrap

If you're just starting out, before you go symlinking everything in ~/*, you may want to check out a few bootstrap projects that take the heavy lifting out of the process. Here are a few of our favorites:

Awesome dotfiles contains articles, tools and other resources to get you up to speed with dotfiles.

Go farther with a framework

For a lot of us, a big chunk of our ~ folder is devoted to our shell and our text editor. Until you're ready to roll your own setup, these projects make customization safe and easy.

Shells

Bash

Fish

Zsh

awesome-zsh-plugins is a list of ZSH plugins, themes and completions compatible with ZSH frameworks like antigen, oh-my-zsh and zgen.

Editors

Emacs

Vim

General-purpose dotfile utilities

Tutorials

Don't ignore your .gitignore

GitHub has a great collection of .gitignore templates for a wide range of languages and editors. We recommend Simon Whitaker's gitignore-boilerplates to help you manage them.

Embrace submodules

Consider using Git submodules as you start to add 3rd party frameworks, scripts, and plugins. Submodules make managing dotfile dependencies so much easier.

FAQ

Why create this site?

Some of your fellow GitHub friends have found incredible value in digging through Other People's Dotfiles (OPD). We aim to share that knowledge with you, our fellow wayfaring stranger in the shell.

You totally need to know about a great bootstrap or framework, how do I submit?

Great! We're always looking for new projects to follow. Please submit a PR or connect with us on Twitter.

Oh no! I've committed passwords/API keys/other sensitive data!

We've got you covered! Take a look at the sensitive data removal guide.

Your FAQ is weak. It so did not answer my question.

That's not a question. But feel free to ask us anything on Twitter, or to create an issue on this repository. Maybe we can expand this list.

Contribute

Want to help out? Great! Submit a feature request, open an issue, or submit a patch.