Readme documentation improvements, rename plugin function

278410916d03b6f464ebe9a10f341ea1629c2cca

Tucker McKnight <tmcknight@instructure.com> | Mon Sep 07 2026

Readme documentation improvements, rename plugin function

Also adds package.json keywords, website field, license, and repo field.
README.md:24
Before
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
   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.
After
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

40
41
42
43
44
   object that describes the name and location of the repositories that you
   want to display.

```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.
main.ts:79
Before
78
79
80
81
82
83
  }
}

export default async function repoViewer(eleventyConfig: any, userConfiguration: ReposConfiguration) {
  const reposConfiguration: ReposConfigurationWithDefaultsApplied = getConfig(userConfiguration)

  const slugify = eleventyConfig.getFilter("slugify")
After
78
79
80
81
82
83
  }
}

export default async function gitStaticSiteUi(eleventyConfig: any, userConfiguration: ReposConfiguration) {
  const reposConfiguration: ReposConfigurationWithDefaultsApplied = getConfig(userConfiguration)

  const slugify = eleventyConfig.getFilter("slugify")
package.json:1
Before
0
1
2
3
4
5
{
  "name": "git-static-site-ui",
  "type": "module",
  "version": "0.1.0",
  "main": "dist/main.js",
  "scripts": {
    "build": "npm run schemas && npm run ts && npm run frontend && npm run css",
After
0
1
2
3
4
5
{
  "name": "git-static-site-ui",
  "type": "module",
  "version": "0.1.1",
  "main": "dist/main.js",
  "scripts": {
    "build": "npm run schemas && npm run ts && npm run frontend && npm run css",
package.json:13
Before
12
13
14
15

16




17
18
19
    "css:watch": "npx sass --watch scss/:dist/css/",
    "test": "vitest"
  },
  "keywords": [],
⁣
  "author": "",
⁣
⁣
⁣
⁣
  "license": "ISC",
  "description": "",
  "devDependencies": {
    "@playwright/test": "^1.63.0",
After
12
13
14
15
16
17
18
19
20
21
22
23
24
    "css:watch": "npx sass --watch scss/:dist/css/",
    "test": "vitest"
  },
  "keywords": ["buildawesome-plugin", "eleventy-plugin", "git", "static", "site", "html", "source control", "vcs", "blog"],
  "homepage": "https://tuckerm.us/repos/git-static-site-ui",
  "author": "Tucker McKnight",
  "repository": {
    "type": "git",
    "url": "git+https://tuckerm.us/repos/git-static-site-ui.git"
  },
  "license": "AGPL-3.0-or-later",
  "description": "",
  "devDependencies": {
    "@playwright/test": "^1.63.0",