Skip to content

Generates a page of your GitHub repositories. Useful for a user/org GitHub Pages site when you're not sure what to put there.

Notifications You must be signed in to change notification settings

timwis/github-directory

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Directory

Generates a page of your GitHub repositories. Useful for a user/org GitHub Pages site when you're not sure what to put there.

screenshot

Usage

Just fork this repository, then rename it <your-username>.github.io. You may need to make a commit for GitHub to generate the site (just add a space to _config.yml or something).

But you'll need to make a change each time you create or change one of your repos, so this page will regenerate.

Prefer to use a project page instead of a user/org page? You'll just have to rename the master branch to gh-pages. You'll have to do that using the GitHub Desktop application or at the command line though. :-/

You can change the way the repositories are sorted by editing _config.yml.

How's it work?

GitHub Pages provides some metadata to Jekyll in the site.github object, including a list of your repositories. That's all there is to it, really.

Development

To customize the theme or make other modifications, you may want to work on the site locally. The GitHub Pages gem can simulate the GitHub Pages environment.

  • Install Jekyll
  • Fork this repo
  • Install dependencies via bundle install
  • Run the Jekyll site via bundle exec jekyll serve

About

Generates a page of your GitHub repositories. Useful for a user/org GitHub Pages site when you're not sure what to put there.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages