ipfs · jessicaschilling · Jul 27, 2020 · Jul 24, 2020 · Jul 24, 2020 · Jul 24, 2020
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,22 @@
+name: Build
+on:
+  push:
+
+jobs:
+  no-uncommitted-changes:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+    - name: Run Build
+      uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - run: npm run build    
+    - name: Check working tree
+      id: changes
+      uses: UnicornGlobal/[email protected]
+    - name: Check for uncommited changes
+      if: steps.changes.outputs.changed == 1
+      run: git status && echo "Output does not match src/, uncommitted changes exist, follow build instructions from README" && exit 1
diff --git a/README.md b/README.md
@@ -1,37 +1,47 @@
 # dir-index-html
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
-[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)
+[![Made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
+[![Project: IPFS](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)
 [![Matrix](https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat-square)](https://matrix.to/#/room/#ipfs:matrix.org)
 [![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 
-> Directory listing HTML for go-ipfs gateways
+> Directory listing HTML for `go-ipfs` gateways
 
-This repo is not be used standalone. It's used by the gateway code in go-ipfs. It'll be merged into the gateway package, once the gateway has been extracted from go-ipfs.
+**NOTE:** This repo is not intended to be used as a standalone project! This code is used by the gateway code within [`go-ipfs`](https://github.com/ipfs/go-ipfs). In the long term, once the the gateway is extracted from `go-ipfs`, the code in this repo will be merged into that gateway package.
 
 ![](https://user-images.githubusercontent.com/157609/88379209-ce6f0600-cda2-11ea-9620-20b9237bb441.png)
 
 ## Updating
 
-1. Make changes to _both_ dir-index.html and dir-index-uncat.html.
-2. Follow the instructions in [go-ipfs](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index.
+When making updates to the directory listing page template, please note the following:
+
+1. Make your changes to the (human-friendly) source documents in the `src` directory
+2. Before testing or releasing, make sure to run the build script to update the minified version in the top-level directory:
+
+```bash
+> npm run build
+```
+3. To get your updates into `go-ipfs`, you'll need to do the following:
+     - Cut a new, appropriately versioned release of `dir-index-html` (don't forget to bump the version number in `package.json`)
+     - Make a PR against `go-ipfs` following [these instructions](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index
 
 ## Testing
 
-1. Install [go](https://golang.org/dl/).
-2. Run the test server:
+1. Make sure you have [Go](https://golang.org/dl/) installed
+2. Start the test server, which lives in its own directory:
 
 ```bash
 > cd test
 > go run .
 ```
+This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page.
 
-This will listen on `localhost:3000` and re-load the template every time you refresh the page.
+If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `npm run build` to generate the minified artifact that the test is looking for.
 
 ## Contribute
 
-Feel free to join in. All welcome. A good place to start is [the issues](https://github.com/ipfs/dir-index-html/issues).
+Feel free to join in. All are welcome! A good place to start is to check the [issues](https://github.com/ipfs/dir-index-html/issues) for anything you find interesting.
 
 This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 

diff --git a/dir-index-uncat.html b/dir-index-uncat.html
diff --git a/dir-index.html b/dir-index.html
diff --git a/gw-assets/icons.css b/gw-assets/icons.css
diff --git a/gw-assets/style.css b/gw-assets/style.css
diff --git a/package.json b/package.json
@@ -1,5 +1,9 @@
 {
+  "name": "dir-index-html",
   "author": "lgierth",
+  "description": "Directory listing HTML for go-ipfs gateways",
+  "version": "1.2.0",
+  "homepage": "https://github.com/ipfs/dir-index-html#readme",
   "bugs": {
     "url": "https://github.com/ipfs/dir-index-html"
   },
@@ -11,8 +15,13 @@
   "gxVersion": "0.14.0",
   "language": "go",
   "license": "MIT",
-  "name": "dir-index-html",
   "releaseCmd": "git commit -a -m \"gx publish $VERSION\"",
-  "version": "1.0.4"
+  "scripts": {
+    "build": "npm run build:clean && npm run build:remove-style-links && npm run build:minify-wrap-css && npm run build:combine-html-css && npm run build:remove-unused",
+    "build:clean": "rm dir-index.html",
+    "build:remove-style-links": "sed '/<link rel=\"stylesheet\"/d' ./src/dir-index.html > ./base-html.html",
+    "build:minify-wrap-css": "(echo \"<style>\" && cat ./src/icons.css ./src/style.css | tr -d \"\t\n\r\" && echo -e \"\\n</style>\") > ./minified-wrapped-style.html",
+    "build:combine-html-css": "sed '/<head>/ r ./minified-wrapped-style.html' ./base-html.html > ./dir-index.html",
+    "build:remove-unused": "rm ./base-html.html && rm ./minified-wrapped-style.html"
+  }
 }
-
diff --git a/src/dir-index.html b/src/dir-index.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+{{ $root := . }}
+<html>
+<head>
+<meta charset="utf-8" />
+<meta name="description" content="A directory of files hosted on the distributed, decentralized web using IPFS">
+<meta property="og:title" content="Files on IPFS">
+<meta property="og:description" content="{{ .Path }}">
+<meta property="og:type" content="website">
+<meta property="og:image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="twitter:title" content="{{ .Path }}">
+<meta name="twitter:description" content="A directory of files hosted on the distributed, decentralized web using IPFS">
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="twitter:creator" content="@ipfs">
+<meta name="twitter:site" content="@ipfs">
+<meta name="image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlo89/56ZQ/8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACUjDu1lo89/6mhTP+zrVP/nplD/5+aRK8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHNiIS6Wjz3/ubFY/761W/+vp1D/urRZ/8vDZf/GvmH/nplD/1BNIm8AAAAAAAAAAAAAAAAAAAAAAAAAAJaPPf+knEj/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf+tpk7/nplD/wAAAAAAAAAAAAAAAJaPPf+2rVX/vrVb/761W/++tVv/vrVb/6+nUP+6tFn/y8Nl/8vDZf/Lw2X/y8Nl/8G6Xv+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/761W/+vp1D/urRZ/8vDZf/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf++tVv/vrVb/761W/++tVv/vbRa/5aPPf+emUP/y8Nl/8vDZf/Lw2X/y8Nl/8vDZf+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/5qTQP+inkb/op5G/6KdRv/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/sqlS/56ZQ//LxWb/0Mlp/9DJaf/Kw2X/oJtE/7+3XP/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf+9tFr/mJE+/7GsUv/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+xrFL/nplD/8vDZf+emUP/AAAAAAAAAACWjz3/op5G/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+inkb/nplD/wAAAAAAAAAAAAAAAKKeRv+3slb/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+1sFX/op5G/wAAAAAAAAAAAAAAAAAAAAAAAAAAop5GUKKeRv/Nxmf/0cpq/9HKav/Rymr/0cpq/83GZ/+inkb/op5GSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G16KeRv/LxWb/y8Vm/6KeRv+inkaPAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G/6KeRtcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/n8AAPgfAADwDwAAwAMAAIABAACAAQAAgAEAAIABAACAAQAAgAEAAIABAACAAQAAwAMAAPAPAAD4HwAA/n8AAA==" />
+<link rel="stylesheet" href="style.css"/>
+<link rel="stylesheet" href="icons.css">
+<title>{{ .Path }}</title>
+</head>
+<body>
+  <div id="page-header">
+    <div id="page-header-logo" class="ipfs-logo">&nbsp;</div>
+    <div id="page-header-menu">
+      <div class="menu-item-wide"><a href="https://ipfs.io" target="_blank" rel="noopener noreferrer">About IPFS</a></div>
+      <div class="menu-item-wide"><a href="https://ipfs.io#install" target="_blank" rel="noopener noreferrer">Install IPFS</a></div>
+      <div class="menu-item-narrow"><a href="https://ipfs.io" target="_blank" rel="noopener noreferrer">About</a></div>
+      <div class="menu-item-narrow"><a href="https://ipfs.io#install" target="_blank" rel="noopener noreferrer">Install</a></div>
+      <div>
+        <a href="https://github.com/ipfs/dir-index-html/issues/" target="_blank" rel="noopener noreferrer">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 18.4 21"><circle cx="7.5" cy="4.8" r="1"/><circle cx="11.1" cy="4.8" r="1"/><path d="M12.7 8.4c-0.5-1.5-1.9-2.5-3.5-2.5 -1.6 0-3 1-3.5 2.5H12.7z"/><path d="M8.5 9.7H5c-0.5 0.8-0.7 1.7-0.7 2.7 0 2.6 1.8 4.8 4.2 5.2V9.7z"/><path d="M13.4 9.7H9.9v7.9c2.4-0.4 4.2-2.5 4.2-5.2C14.1 11.4 13.9 10.5 13.4 9.7z"/><circle cx="15.7" cy="12.9" r="1"/><circle cx="15.1" cy="15.4" r="1"/><circle cx="15.3" cy="10.4" r="1"/><circle cx="2.7" cy="12.9" r="1"/><circle cx="3.3" cy="15.4" r="1"/><circle cx="3.1" cy="10.4" r="1"/></svg>
+        </a>
+      </div>
+    </div>
+  </div>
+  <div id="content">
+    <div id="content-header" class="d-flex flex-wrap">
+      <div>
+        <strong>
+          Index of
+          {{ range .Breadcrumbs -}}
+          /{{ if .Path }}<a href="{{ $root.GatewayURL }}{{ .Path | urlEscape }}">{{ .Name }}</a>{{ else }}{{ .Name }}{{ end }}
+          {{- else }}
+          {{ .Path }}
+          {{ end }}
+        </strong>
+        {{ if .Hash }}
+        <div class="ipfs-hash">
+          {{ .Hash }}
+        </div>
+        {{ end }}
+      </div>
+      {{ if .Size }}
+      <div class="no-linebreak flex-shrink-1 ml-auto">
+        <strong>&nbsp;{{ .Size }}</strong>
+      </div>
+      {{ end }}
+    </div>
+    <div class="table-responsive">
+    <table>
+      <tr>
+        <td class="type-icon">
+          <div class="ipfs-_blank">&nbsp;</div>
+        </td>
+        <td>
+          <a href="{{.BackLink | urlEscape}}">..</a>
+        </td>
+        <td></td>
+        <td></td>
+      </tr>
+      {{ range .Listing }}
+      <tr>
+        <td class="type-icon">
+          <div class="{{iconFromExt .Name}}">&nbsp;</div>
+        </td>
+        <td>
+          <a href="{{ .Path | urlEscape }}">{{ .Name }}</a>
+        </td>
+        <td class="no-linebreak">
+          {{ if .Hash }}
+          <a class="ipfs-hash" href="{{ $root.GatewayURL }}/ipfs/{{ .Hash | urlEscape }}">
+            {{ .ShortHash }}
+          </a>
+          {{ end }}
+        </td>
+        <td class="no-linebreak">{{ .Size }}</td>
+      </tr>
+      {{ end }}
+    </table>
+    </div>
+  </div>
+</body>
+</html>