Permalink
Browse files

Initial content, updated README

  • Loading branch information...
1 parent 9e1da0d commit f74639423506af52912aa92ea013fdf6dcf0fe92 @pengwynn pengwynn committed Apr 23, 2012
View
@@ -1,4 +1,15 @@
dotfiles.github.com
===================
-Unofficial guide to doing dotfiles on GitHub.
+Your _unofficial_ guide to doing dotfiles on GitHub.
+
+Please visit [http://dotfiles.github.com](http://dotfiles.github.com).
+
+## Contributing
+
+If you'd like to contribute to this site, you'll need [nanoc](http://nanoc.stoneship.org/) the awesome static site generator from [Denis Defreyne](http://stoneship.org/).
+
+This site is served from GitHub pages and the source resides in the [src folder](). Other than the usual [nanoc usage info](http://nanoc.stoneship.org/docs/), it's important to note:
+
+* *Add exclusions for any root content not generated by nano.* This is done in the `src/config.yml` under `exclusions.` These exclusions won't get pruned for the `nanoc prune` command.
+
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -1,54 +1,117 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html lang='en'>
+<html>
<head>
<meta charset='utf-8' />
+ <meta content='chrome=1' http-equiv='X-UA-Compatible' />
<title>
- A Brand New nanoc Site -
- Wynn's home
+ GitHub does dotfiles
+ - dotfiles.github.com
</title>
- <link href='/stylesheets/styles.css' media='screen' rel='stylesheet' type='text/css' />
- <meta content='nanoc 3.3.3' name='generator' />
+ <link href='/stylesheets/styles.css' rel='stylesheet' />
+ <meta content='width=device-width, initial-scale=1, user-scalable=no' name='viewport' />
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
</head>
<body>
- <div id='main'>
- <h1>A Brand New nanoc Site</h1>
- <p>You’ve just created a new nanoc site. The page you are looking at right now is the home page for your site. To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
- <ul>
- <li>
- <p>
- <strong>Change this page’s content</strong>
- by editing the “index.html” file in the “content” directory. This is the actual page content, and therefore doesn’t include the header, sidebar or style information (those are part of the layout).
- </p>
- </li>
- <li>
- <p><strong>Change the layout</strong>, which is the “default.html” file in the “layouts” directory, and create something unique (and hopefully less bland).
- </p>
- </li>
- </ul>
- <p>If you need any help with customizing your nanoc web site, be sure to check out the documentation (see sidebar), and be sure to subscribe to the discussion group (also see sidebar). Enjoy!</p>
- </div>
- <div id='sidebar'>
- <h2>Documentation</h2>
- <ul>
- <li>
- <a href='http://nanoc.stoneship.org/docs/'>Documentation</a>
- </li>
- <li>
- <a href='http://nanoc.stoneship.org/docs/3-getting-started/'>Getting Started</a>
- </li>
- </ul>
- <h2>Community</h2>
- <ul>
- <li>
- <a href='http://groups.google.com/group/nanoc/'>Discussion Group</a>
- </li>
- <li>
- <a href='irc://chat.freenode.net/#nanoc'>IRC Channel</a>
- </li>
- <li>
- <a href='http://projects.stoneship.org/trac/nanoc/'>Wiki</a>
- </li>
- </ul>
+ <div class='wrapper'>
+ <header>
+ <img alt='Forktocat' src='/images/forktocat.jpg' />
+ <h1>dotfiles.github.com</h1>
+ <p>
+ <em>Your unofficial guide to dotfiles on GitHub.</em>
+ </p>
+ </header>
+ <section>
+ <h1>
+ GitHub ❤
+ <span class='mono'>~/</span>
+ </h1>
+ <p>Why would I want my dotfiles on GitHub?</p>
+
+ <ul>
+ <li><strong><em>Backup</em></strong>, <strong><em>restore</em></strong>, and <strong><em>sync</em></strong> the prefs and settings for your toolbox. Your dotfiles might be the most important files on your machine.</li>
+ <li><strong><em>Learn</em></strong> from the community. Discover new tools for your toolbox and new tricks for the ones you already use.</li>
+ <li><strong><em>Share</em></strong> what you've learned with the rest of us.</li>
+ </ul>
+
+
+ <h2>Get started with a bootstrap</h2>
+
+ <p>If you're just starting out, before you go symlinking everything in <code>~/*</code>,
+ you may want to check out a few boostrap projects that take the heavy lifting
+ out of the process. Here are a few of our favorites:</p>
+
+ <ul>
+ <li><a href="https://github.com/holman/dotfiles">Zach Holman's dotfiles</a> features topical
+ organization, auto sourcing zsh files, easy zsh completion extensions, a local
+ bin folder for executables. The included Rakefile will symlink anything ending
+ in <code>.symlink</code> to your <code>~</code> folder.</li>
+ <li><a href="https://github.com/mathiasbynens/dotfiles">Mathias Bynens' dotfiles</a> includes
+ a bootstrap script that rsyncs your repo to your home folder.
+ Mathias' <a href="https://github.com/mathiasbynens/dotfiles/blob/master/.osx">OS X defaults script</a> is legendary.</li>
+ <li><a href="https://github.com/skwp/dotfiles">Yan Pritzker's dotfiles</a> bundles an
+ opinionated set of Vim plugins and Zsh setup all tuned for using
+ <a href="http://ethanschoonover.com/solarized">Solarized</a> on OS X.</li>
+ <li><a href="https://github.com/technicalpickles/homesick">Josh Nichols' Homesick</a> makes it easy to symlink and clone dotfiles repos.</li>
+ </ul>
+
+
+ <h2>Go farther with a framework</h2>
+
+ <p>For a lot of us, a big chunk of our <code>~</code> 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.</p>
+
+ <ul>
+ <li><a href="https://github.com/robbyrussell/oh-my-zsh">oh-my-zsh</a> is a community-driven framework for managing your zsh configuration. It bundles 40+ plugins and 80+ themes.</li>
+ <li><a href="https://github.com/revans/bash-it">bash-it</a> is a "shameless ripoff of oh-my-zsh," but for bash.</li>
+ <li><a href="https://github.com/carlhuda/janus">Janus</a> is a distribution of plug-ins and mappings for Vim, Gvim and MacVim.</li>
+ </ul>
+ <h2>FAQ</h2>
+ <dl class='faq'>
+ <dt>Why create this site?</dt>
+ <dd>
+ Some of your
+ <a href='http://github.com/dotfiles'>
+ fellow GitHub friends
+ </a>
+ 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.
+ </dd>
+ <dt>You totally need to know about <code>/my|a/</code> great <code>/bootstrap|framework/</code>, how do I submit?</dt>
+ <dd>
+ Great! We're always looking for new projects to follow. Please
+ <a href='http://twitter.com/octodots'>connect with us on Twitter.</a>
+ </dd>
+ <dt>Your FAQ is weak. It so did not answer my question.</dt>
+ <dd>
+ That's not a question. But feel free to ask
+ <a href='http://twitter.com/octodots'>ask us anything on Twitter.</a>
+ Maybe we can expand this list.
+ </dd>
+ </dl>
+ <h2>Contribute</h2>
+
+ <p>Want to help out? Great! Submit a <a href="https://github.com/dotfiles/dotfiles.github.com/issues">feature request</a>, <a href="https://github.com/dotfiles/dotfiles.github.com/issues">open an issue</a>, or <a href="https://github.com/dotfiles/dotfiles.github.com">submit a patch</a>.</p>
+ </section>
+ <footer>
+ <p>
+ <a class='twitter-follow-button' data-show-count='false' href='https://twitter.com/octodots'>Follow @octodots</a>
+ </p>
+ <p>
+ <small>
+ Hosted on GitHub Pages &mdash; Theme by
+ <a href='https://github.com/orderedlist'>orderedlist.</a>
+ </small>
+ <small>
+ <a href='http://octodex.github.com/forktocat/'>Forktocat logo</a>
+ by
+ <a href='https://github.com/cameronmcefee'>Cameron McEfee.</a>
+ </small>
+ </p>
+ </footer>
</div>
+ <script src='/javascripts/scale.fix.js'></script>
+ <script src='//platform.twitter.com/widgets.js'></script>
</body>
</html>
File renamed without changes.
View
@@ -27,7 +27,7 @@ prune:
# Which files and directories you want to exclude from pruning. If you version
# your output directory, you should probably exclude VCS directories such as
# .git, .svn etc.
- exclude: [ '.git', '.hg', '.svn', 'CVS', 'src', '.gitignore', 'README.md']
+ exclude: [ '.git', '.hg', '.svn', 'CVS', 'src', '.gitignore', 'README.md', 'images']
# The data sources where nanoc loads its data from. This is an array of
# hashes; each array element represents a single data source. By default,
View
@@ -1,16 +1,77 @@
---
-title: Wynn's home
+title: GitHub does dotfiles
---
-%h1 A Brand New nanoc Site
-%p You’ve just created a new nanoc site. The page you are looking at right now is the home page for your site. To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:
-%ul
- %li
- %p
- %strong Change this page’s content
- by editing the “index.html” file in the “content” directory. This is the actual page content, and therefore doesn’t include the header, sidebar or style information (those are part of the layout).
- %li
- %p
- %strong> Change the layout
- , which is the “default.html” file in the “layouts” directory, and create something unique (and hopefully less bland).
-%p If you need any help with customizing your nanoc web site, be sure to check out the documentation (see sidebar), and be sure to subscribe to the discussion group (also see sidebar). Enjoy!
+%h1
+ GitHub ❤
+ %span.mono ~/
+
+:markdown
+
+ Why would I want my dotfiles on GitHub?
+
+ * **_Backup_**, **_restore_**, and **_sync_** the prefs and settings for your toolbox. Your dotfiles might be the most important files on your machine.
+ * **_Learn_** from the community. Discover new tools for your toolbox and new tricks for the ones you already use.
+ * **_Share_** what you've learned with the rest of us.
+
+ ## 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 boostrap projects that take the heavy lifting
+ out of the process. Here are a few of our favorites:
+
+ * [Zach Holman's dotfiles](https://github.com/holman/dotfiles) features topical
+ organization, auto sourcing zsh files, easy zsh completion extensions, a local
+ bin folder for executables. The included Rakefile will symlink anything ending
+ in `.symlink` to your `~` folder.
+ * [Mathias Bynens' dotfiles](https://github.com/mathiasbynens/dotfiles) includes
+ a bootstrap script that rsyncs your repo to your home folder.
+ Mathias' [OS X defaults script](https://github.com/mathiasbynens/dotfiles/blob/master/.osx) is legendary.
+ * [Yan Pritzker's dotfiles](https://github.com/skwp/dotfiles) bundles an
+ opinionated set of Vim plugins and Zsh setup all tuned for using
+ [Solarized](http://ethanschoonover.com/solarized) on OS X.
+ * [Josh Nichols' Homesick](https://github.com/technicalpickles/homesick) makes it easy to symlink and clone dotfiles repos.
+
+ ## 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.
+
+ * [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) is a community-driven framework for managing your zsh configuration. It bundles 40+ plugins and 80+ themes.
+ * [bash-it](https://github.com/revans/bash-it) is a "shameless ripoff of oh-my-zsh," but for bash.
+ * [Janus](https://github.com/carlhuda/janus) is a distribution of plug-ins and mappings for Vim, Gvim and MacVim.
+
+
+%h2 FAQ
+
+%dl.faq
+ %dt Why create this site?
+ %dd
+ Some of your
+ %a(href="http://github.com/dotfiles")
+ 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.
+
+ %dt You totally need to know about <code>/my|a/</code> great <code>/bootstrap|framework/</code>, how do I submit?
+ %dd
+ Great! We're always looking for new projects to follow. Please
+ %a(href="http://twitter.com/octodots") connect with us on Twitter.
+ %dt Your FAQ is weak. It so did not answer my question.
+ %dd
+ That's not a question. But feel free to ask
+ %a(href="http://twitter.com/octodots") ask us anything on Twitter.
+ Maybe we can expand this list.
+
+
+:markdown
+
+ ## Contribute
+
+ Want to help out? Great! Submit a [feature request](https://github.com/dotfiles/dotfiles.github.com/issues), [open an issue](https://github.com/dotfiles/dotfiles.github.com/issues), or [submit a patch](https://github.com/dotfiles/dotfiles.github.com).
+
+
+
+
+
+
Oops, something went wrong.

0 comments on commit f746394

Please sign in to comment.