update document

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "docs/themes/loveit"]
 	path = docs/themes/loveit
 	url = https://github.com/dillonzq/LoveIt.git
+[submodule "docs/themes/congo"]
+	path = docs/themes/congo
+	url = https://github.com/jpanther/congo.git

Makefile

@@ -13,6 +13,9 @@ coverage.out: cmd/urleap/main_test.go
 	go test -covermode=count \
 		-coverprofile=coverage.out $(PACKAGE_LIST)
 
+site:
+	make -C docs build_with_hugo
+
 docker: urleap
 #	docker build -t ghcr.io/tamada/urleap:$(VERSION) -t ghcr.io/tamada/urleap:latest .
 	docker buildx build -t ghcr.io/tamada/urleap:$(VERSION) \

docs/Makefile

@@ -0,0 +1,5 @@
+build_with_hugo:
+	hugo
+
+start:
+	hugo server -D

docs/config/_default/config.toml

@@ -0,0 +1,10 @@
+baseURL = "https://tamada.github.io/urleap"
+defaultContentLanguage = "en"
+theme = "congo"
+title = "urleap"
+
+enableRobotTXT = "true"
+paginate = 15
+
+[outputs]
+    home = ["HTML", "RSS", "JSON"]

docs/config/_default/languages.en.toml

@@ -0,0 +1,9 @@
+languageName = "English"
+copyright = "(C) 2023 Haruaki TAMADA"
+
+[params]
+    dateFormat = "2006-01-02"
+
+[author]
+    name = "Haruaki Tamada"
+    image = "harry.png"

docs/config/_default/markup.toml

@@ -0,0 +1,13 @@
+# -- Markup --
+# These settings are required for the theme to function.
+
+[goldmark]
+[goldmark.renderer]
+  unsafe = true
+
+[highlight]
+  noClasses = false
+
+[tableOfContents]
+  startLevel = 2
+  endLevel = 3

docs/config/_default/menus.en.toml

@@ -0,0 +1,40 @@
+# -- Main Menu --
+# The main menu is displayed in the header at the top of the page.
+# Acceptable parameters are name, pageRef, page, url, title, weight.
+#
+# The simplest menu configuration is to provide:
+#   name = The name to be displayed for this menu link
+#   pageRef = The identifier of the page or section to link to
+#
+# By default the menu is ordered alphabetically. This can be
+# overridden by providing a weight value. The menu will then be
+# ordered by weight from lowest to highest.
+
+# [[main]]
+#   name = "Users"
+#   pageRef = "users"
+#   weight = 10
+
+[[main]]
+  name = "GitHub"
+  url = "https://github.com/tamada/urleap"
+  weight = 40
+  [main.params]
+    icon = "github"
+    showName = false
+    target = "_blank"
+
+[[main]]
+  identifier = "search"
+  weight = 99
+  [main.params]
+    action = "search"
+
+# -- Footer Menu --
+# The footer menu is displayed at the bottom of the page, just before
+# the copyright notice. Configure as per the main menu above.
+
+# [[footer]]
+#   name = "Tags"
+#   pageRef = "tags"
+#   weight = 10

docs/config/_default/module.toml

@@ -0,0 +1,2 @@
+[[imports]]
+path = "github.com/jpanther/congo/v2"

docs/config/_default/params.toml

@@ -0,0 +1,5 @@
+enableSearch = true
+enableCodeCopy = true
+
+[header]
+    logo = "urleap.png"

docs/content/_index.md

@@ -2,8 +2,6 @@
 title: "urleap"
 ---
 
-# urleap
-
 URL shortener via bit.ly, etc.
 
 [![build](https://github.com/tamada/urleap/actions/workflows/build.yml/badge.svg)](https://github.com/tamada/urleap/actions/workflows/build.yml)
@@ -111,4 +109,4 @@ docker run -it --rm tamada/urleap:latest -t <token> <url...>
 
 ### :jack_o_lantern: Icon
 
-![Icon](docs/static/images/urleap.svg)
+![Icon](assets/urleap.svg)

docs/go.mod

@@ -0,0 +1,5 @@
+module github.com/tamada/urleap/docs
+
+go 1.20
+
+require github.com/jpanther/congo/v2 v2.6.1 // indirect

docs/go.sum

@@ -0,0 +1,2 @@
+github.com/jpanther/congo/v2 v2.6.1 h1:iA8uosVsiMl3JbBSBwMvrxEibzBcDp+RIj18f/cmlDs=
+github.com/jpanther/congo/v2 v2.6.1/go.mod h1:1S7DRoO1ZYS4YUdFd1LjTkdyjQwsjFWd8TqSfz3Jd+M=