diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 20efd0d9..00000000 --- a/.gitmodules +++ /dev/null @@ -1,4 +0,0 @@ -[submodule "hugo-whisper-theme"] - path = docs/themes/hugo-whisper-theme - url = https://github.com/deining/hugo-whisper-theme.git - branch = deprecation-warning diff --git a/Makefile b/Makefile index 62b994fb..2ac24ad4 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ docs: @echo " (x x) < memefish: docs" @echo " /|||\\" @echo - cd docs && hugo + cd docs && hugo mod get -u && hugo .PHONY: ci ci: lint test diff --git a/docs/config.toml b/docs/config.toml deleted file mode 100644 index 2d9b45d7..00000000 --- a/docs/config.toml +++ /dev/null @@ -1,36 +0,0 @@ -baseurl = "https://cloudspannerecosystem.github.io/memefish" -title = "méméfish" -theme = "hugo-whisper-theme" -languagecode = "en" -defaultcontentlanguage = "en" - -paginate = 20 -canonifyurls = true - -pygmentsstyle = "bw" -pygmentscodefences = true -pygmentscodefencesguesssyntax = true - -summaryLength = 30 - -[params] - homepage_button_link = "/docs" - homepage_button_text = "Read The Docs" - homepage_intro = "Spanner SQL parser for Go" - - [params.logo] - mobile = "/images/memefish.svg" - standard = "/images/memefish.svg" - -[[menu.main]] - name = "Docs" - weight = 1 - url = "/docs/" -[[menu.main]] - name = "GoDoc" - weight = 3 - url = "https://pkg.go.dev/github.com/cloudspannerecosystem/memefish" -[[menu.main]] - name = "GitHub" - weight = 3 - url = "https://github.com/cloudspannerecosystem/memefish" diff --git a/docs/content/docs/_index.md b/docs/content/_index.md similarity index 92% rename from docs/content/docs/_index.md rename to docs/content/_index.md index bd5681ed..e4cadb7c 100644 --- a/docs/content/docs/_index.md +++ b/docs/content/_index.md @@ -1,9 +1,9 @@ --- -title: README +title: Home ---

- +

# méméfish diff --git a/docs/content/docs/example-parse/index.md b/docs/content/example-parse/_index.md similarity index 100% rename from docs/content/docs/example-parse/index.md rename to docs/content/example-parse/_index.md diff --git a/docs/go.mod b/docs/go.mod new file mode 100644 index 00000000..89b35ca7 --- /dev/null +++ b/docs/go.mod @@ -0,0 +1,5 @@ +module github.com/couldspannerecosystem/memefish/docs + +go 1.21.0 + +require github.com/thingsym/hugo-theme-techdoc v1.0.1 // indirect diff --git a/docs/go.sum b/docs/go.sum new file mode 100644 index 00000000..cd9e2381 --- /dev/null +++ b/docs/go.sum @@ -0,0 +1,2 @@ +github.com/thingsym/hugo-theme-techdoc v1.0.1 h1:YesixDLh7bRLFpcoyqflL3KUA+VFFw4l/9g/PuRHa4M= +github.com/thingsym/hugo-theme-techdoc v1.0.1/go.mod h1:LTThnoCpG8nsum5q10OLrG1LdJNI3BXzV4Qr557cmAY= diff --git a/docs/hugo.toml b/docs/hugo.toml new file mode 100644 index 00000000..55752e3f --- /dev/null +++ b/docs/hugo.toml @@ -0,0 +1,52 @@ +theme = "github.com/thingsym/hugo-theme-techdoc" + +baseURL = "https://cloudspannerecosystem.github.io/memefish" +title = "méméfish" +languageCode = "en-US" +defaultContentLanguage = "en" + +canonifyurls = true + +pygmentsstyle = "bw" +pygmentscodefences = true +pygmentscodefencesguesssyntax = true + +summaryLength = 30 + +[markup] + defaultMarkdownHandler = "goldmark" + [markup.goldmark.renderer] + unsafe= true + [markup.tableOfContents] + startLevel = 2 + endLevel = 6 + ordered = false + +[params] + description = "Spanner SQL parser for Go" + github_repository = "https://github.com/cloudspannerecosystem/memefish" + version = "" + + github_doc_repository = "https://github.com/cloudspannerecosystem/memefish" + github_doc_repository_branch = "main" + github_doc_repository_path = "docs" + + menu_style = "open-menu" + +[menu] + [[menu.main]] + name = "Docs" + weight = 1 + url = "/" + [[menu.main]] + name = "GoDoc" + weight = 2 + url = "https://pkg.go.dev/github.com/cloudspannerecosystem/memefish" + [[menu.main]] + name = "GitHub" + weight = 3 + url = "https://github.com/cloudspannerecosystem/memefish" + +[module] + [[module.imports]] + path = "github.com/thingsym/hugo-theme-techdoc" diff --git a/docs/layouts/_default/list.html b/docs/layouts/_default/list.html deleted file mode 100644 index b23d3759..00000000 --- a/docs/layouts/_default/list.html +++ /dev/null @@ -1,12 +0,0 @@ -{{ define "header_css" }}{{ end }} -{{ define "body_classes" }}page-default-list{{ end }} -{{ define "header_classes" }}{{ end }} - -{{ define "main" }} - -

{{ .Title }}

-
- {{ .Content }} -
- -{{ end }} diff --git a/docs/layouts/partials/sub-footer.html b/docs/layouts/partials/sub-footer.html deleted file mode 100644 index 47be19c9..00000000 --- a/docs/layouts/partials/sub-footer.html +++ /dev/null @@ -1,16 +0,0 @@ -
-
-
-
-
- -
-
-
-
-
- \ No newline at end of file diff --git a/docs/static/images/terminal.svg b/docs/static/images/terminal.svg deleted file mode 120000 index ae07bd85..00000000 --- a/docs/static/images/terminal.svg +++ /dev/null @@ -1 +0,0 @@ -../../../images/terminal.svg \ No newline at end of file diff --git a/docs/themes/hugo-whisper-theme b/docs/themes/hugo-whisper-theme deleted file mode 160000 index 8c982a74..00000000 --- a/docs/themes/hugo-whisper-theme +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 8c982a7455d544881d3bea6e137a6b574b9cb176