# What Is This?
Git Static Site UI is a plugin for [Build Awesome](https://11ty.dev) 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. A Build Awesome-generated website set up. You'll need to make a couple of additions
to your 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/eleventy-repo-viewer.git#deploy/0.0.1-alpha.1`
2. Add this plugin to your eleventy config, giving it a repo configuration
object that describes the name and location of the repositories that you
want to display.
```diff-js
+ import repoViewer from 'eleventy-repo-viewer'
export default (eleventyConfig) => {
+ eleventyConfig.addPlugin(repoViewer, {
+ repos: {
+ "My Cool Project": {
+ location: "/home/me/code/cool-project",
+ defaultBranch: 'main',
+ branches: ['main', 'develop', 'release/**'],
+ },
+ },
+ path: "/repos",
+ baseUrl: "https://example.com",
+ })
}
```
RSS