What Is This?

Eleventy Repo Viewer is a plugin for Eleventy that creates plain, static HTML pages for displaying a git repository. You can read code, browse commits, and clone the repository purely from plain old files on a web server. It's sort of like a read-only version of GitHub, and requires no logic on the backend whatsoever.

Installation and Setup

Prerequisites

1. git, which you probably already have
2. An 11ty website set up. You'll need to mmake a couple of additions to your eleventy config file.

Installation & Setup

1. npm install this plugin

   This is not (yet) on npm. You can install it straight from this git repository, though. npm install --save git+http://repos.tuckerm.us/repos/eleventy-repo-viewer.git#deploy/0.0.1-alpha.1

2. Add this plugin to your eleventy config.

+import repoViewer from 'eleventy-repo-viewer'

export default (eleventyConfig) => {
  eleventyConfig.addPlugin(repoViewer, {
    repos: {
      "My Cool Project": {
        _type: "git",
        location: "/home/me/code/cool-project",
        defaultBranch: 'main',
        branchesToPull: ['main', 'develop'],
      },
    },
    path: "/repos",
    baseUrl: "https://example.com",
  })
}

3. Edit reposConfig.ts to describe the repositories that you want to show on your site. See below for a more detailed description of the reposConfig.ts file.