mirror of https://github.com/ipfs/kubo.git synced 2026-02-25 04:17:44 +08:00

History

Steven Allen e09b65cb5a docs: document dir-index-html		2020-04-21 15:27:08 -07:00
..
dir-index-html@545a1fd882	feat: update dir index	2020-04-21 15:16:17 -07:00
init-doc	quick-start: fix typo	2020-04-06 03:15:45 +02:00
assets_test.go	assets: move away from gx	2019-06-11 15:36:47 -07:00
assets.go	assets: move away from gx	2019-06-11 15:36:47 -07:00
bindata_dep.go	chore(dep): update deps	2020-03-13 11:20:46 -07:00
bindata.go	feat: update dir index	2020-04-21 15:16:17 -07:00
README.md	docs: document dir-index-html	2020-04-21 15:27:08 -07:00

README.md

Assets loaded in with IPFS

This directory contains the go-ipfs assets:

Getting started documentation (init-doc).
Directory listing HTML template (dir-index-html git submodule).

These assets are compiled into bindata.go with go generate.

Re-generating

Do not edit the .go files directly.

Instead, edit the source files and use go generate from within the assets directory:

go generate .

Updating dir-index-html

Upstream: https://github.com/ipfs/dir-index-html

dir-index-html is a git submodule. To update, run the following commands from this directory.

> git -C dir-index-html pull
> git -C dir-index-html checkout vX.Y.Z # target version

Then, you'll need to commit the updated submodule before regenerating bindata.go. Otherwise, go generate will checkout the checked-in version of dir-index-html.

> git add dir-index-html
> git commit -m 'chore: update dir-index-html to vX.Y.Z'

Finally, re-generate the directory index HTML template and amend the previous commit.

> go generate .
> git add bindata.go
> git commit --amend --no-edit