Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
README.md

github-files

A simple jQuery plugin that pulls a file from github.com and returns it.

This uses the public GitHub API (v3) over JSONP to pull a raw file from GitHub.

API:

$.getGithubFile(user, repo, sha, callback, startLineNum, endLineNum)

or

$.getGithubFileByFilePath(user, repo, filePath, callback, startLineNum, endLineNum)

Examples:

// fetch this README.md file and return all of the lines
$.getGithubFile("jamesward", "github-files", "2e7bf4aa35758d7a9cf87549d6299e924737ff05", function(contents) {
    console.log(contents)
});

// fetch this README.md file and return all of the lines beginning with line 6
$.getGithubFile("jamesward", "github-files", "2e7bf4aa35758d7a9cf87549d6299e924737ff05", function(contents) {
    console.log(contents)
}, 6);

// fetch this README.md file and return lines 6 - 15
$.getGithubFile("jamesward", "github-files", "2e7bf4aa35758d7a9cf87549d6299e924737ff05", function(contents) {
    console.log(contents)
}, 6, 15);

// fetch this README.md file and return all of the lines
$.getGithubFileByFilePath("jamesward", "github-files", "README.md", function(contents) {
    console.log(contents)
});

To get the sha for a file in git run something like:

git rev-parse HEAD:README.md

or use the $.getGithubFileByFilePath method as documented above.

Something went wrong with that request. Please try again.