Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use techdoc for Hugo theme #103

Merged
merged 2 commits into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .gitmodules

This file was deleted.

2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
36 changes: 0 additions & 36 deletions docs/config.toml

This file was deleted.

4 changes: 2 additions & 2 deletions docs/content/docs/_index.md → docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: README
title: Home
---

<p align="center">
<img src="images/memefish.png" width="220px">
<img src="images/memefish.svg" width="220px">
</p>

# méméfish
Expand Down
5 changes: 5 additions & 0 deletions docs/go.mod
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions docs/go.sum
Original file line number Diff line number Diff line change
@@ -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=
52 changes: 52 additions & 0 deletions docs/hugo.toml
Original file line number Diff line number Diff line change
@@ -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"
12 changes: 0 additions & 12 deletions docs/layouts/_default/list.html

This file was deleted.

16 changes: 0 additions & 16 deletions docs/layouts/partials/sub-footer.html

This file was deleted.

1 change: 0 additions & 1 deletion docs/static/images/terminal.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/themes/hugo-whisper-theme
Submodule hugo-whisper-theme deleted from 8c982a
Loading