aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2022-07-13 01:13:59 -0400
committerPaul Duncan <pabs@pablotron.org>2022-07-13 01:13:59 -0400
commit6383bdad881378f086fcd20914d7426717464ee9 (patch)
tree32b1cfa3b5ddb63f55aa472f7c268a76098adb08 /README.md
parent380f45eef274eb1f4966487635e8afa84654c5d7 (diff)
downloadpablotron.org-6383bdad881378f086fcd20914d7426717464ee9.tar.bz2
pablotron.org-6383bdad881378f086fcd20914d7426717464ee9.zip
README.md: document go-import support
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 42cf3cc..5415159 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,20 @@ To add a new article:
Update `data/projects.yaml` and then run `bin/gen-projects.rb`.
+**Note:** If you want to add [Go][] module, you can set the `type` of
+the entry to `go`, like so:
+
+ - name: "example-go-mod"
+ type: "go"
+ slug: "example-go-mod"
+ repo: "https://github.com/pablotron/example-go-mod"
+ text: "Example Go module."
+
+Adding a `type: go` property in `data/projects.yaml` adds a `go_import`
+property to the project front matter, which adds a `<meta
+name="go-import" content="...">` element to the header of the generated
+page.
+
## Edit Navbar Menu
To add or edit navbar menu entries: