/dotfiles.github.com

Your unofficial guide to doing dotfiles on GitHub.

Primary LanguageCSSMIT LicenseMIT

dotfiles.github.io

Source for dotfiles.github.io, your unofficial guide to doing dotfiles on GitHub.

See the CONTRIBUTING guide for creating great pull requests.

Quick start

Install project dependencies:

script/bootstrap

Boot local web server to preview changes:

script/server

You can now browse to http://localhost:8484 to preview changes.

Publishing changes

Once you're satisfied with your changes, push your topic branch to your remote and open a pull request in the canonical repo at dotfiles/dotfiles.github.com. If your patch is accepted, a project maintainer will merge your changes and publish them to GitHub Pages.

Updating star counts

Some pages of the site order content by star count. To update these counts, you can use script/update-star-count.py (the maintainers will run this script periodically to keep counts up-to-date). For example, run script/update-star-count.py --token $GITHUB_TOKEN _data/utilities.yml.

Follow these instructions to create a personal access token for GitHub.

Copyright

Copyright (c) Wynn Netherland and Adam Jahnke. See LICENSE for details.