Tucker McKnight <tmcknight@instructure.com> | Mon Sep 07 2026
readme documentation corrections
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
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",
+ })
}
```
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
1. npm install this plugin
`npm install --save git-static-site-ui`
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 gitStaticSiteUi, {beforeHook} from 'git-static-site-ui'
+ export default (eleventyConfig) => {
+ const reposConfig = {
+ repos: {
+ "My Cool Project": {
+ location: "/home/me/code/cool-project",
+ defaultBranch: 'main',
+ },
+ },
+ path: "/repos",
+ baseUrl: "https://example.com",
+ }
+
+ eleventyConfig.on("eleventy.beforeConfig", beforeHook(eleventyConfig, reposConfig))
+ eleventyConfig.addPlugin(gitStaticSiteUi, reposConfig)
+ }
```
Then generate your website with `npx @11ty/eleventy --serve`. The generated HTML pages for browsing your git repositories will be at http://localhost:8080/repos.