Adding hugo base dir for gh-pages

.github/workflows/go.yml

@@ -24,4 +24,4 @@ jobs:
         run: go build -v ./...
 
       - name: Test
-        run: go test -v ./...
+        run: go hugo -v ./...

.gitignore

@@ -5,7 +5,7 @@
 *.so
 *.dylib
 
-# Test binary, built with `go test -c`
+# Test binary, built with `go hugo -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "hugo/themes/book"]
+	path = hugo/themes/book
+	url = https://github.com/alex-shpak/hugo-book

.goreleaser.yml

@@ -18,7 +18,7 @@ builds:
 changelog:
   sort: 'asc'
   filters:
-    exclude: ['^docs:', 'demo', '^test:', 'Merge pull request', 'Merge branch']
+    exclude: ['^docs:', 'demo', '^hugo:', 'Merge pull request', 'Merge branch']
 
 brews:
   - tap:

cmd/generate-docs.go

@@ -15,9 +15,9 @@ func init() {
 
 var docsCmd = &cobra.Command{
 	Use:    "generate-docs",
-	Short:  "Print the version of sttr",
+	Short:  "Generate markdown docs for sttr",
 	Hidden: true,
-	Long:   `All software has a version (semantic at best). This is sttr's'`,
+	Long:   `Generate markdown docs for all the commands of sttr`,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		linkHandler := func(name string) string {
 			return fmt.Sprintf(`{{< relref "%s" >}}`, name)

hugo/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/book"]
+	path = themes/book
+	url = https://github.com/alex-shpak/hugo-book

hugo/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

hugo/config.toml

@@ -0,0 +1,87 @@
+baseURL = "https://abhimanyu003.github.io/sttr/"
+languageCode = "en-us"
+title = "sttr"
+theme = "book"
+publishDir = "../website"
+
+# (Optional) Set Google Analytics if you use it to track your website.
+# Always put it on the top of the configuration file, otherwise it won't work
+#googleAnalytics = "UA-XXXXXXXXX-X"
+
+# (Optional) If you provide a Disqus shortname, comments will be enabled on
+# all pages.
+#disqusShortname = "my-site"
+
+# (Optional) Set this to true if you use capital letters in file names
+disablePathToLower = false
+
+# (Optional) Set this to true to enable 'Last Modified by' date and git author
+#  information on 'doc' type pages.
+enableGitInfo = false
+
+# (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy.
+# You can remove related files with config below
+disableKinds = ['taxonomy', 'taxonomyTerm']
+
+[menu]
+[[menu.after]]
+name = "Source code"
+url = "https://github.com/abhimanyu003/sttr"
+weight = -100
+
+[params]
+  # (Optional, default light) Sets color theme: light, dark or auto.
+  # Theme 'auto' switches between dark and light modes based on browser/os preferences
+  BookTheme = 'auto'
+
+  # (Optional, default true) Controls table of contents visibility on right side of pages.
+  # Start and end levels can be controlled with markup.tableOfContents setting.
+  # You can also specify this parameter per page in front matter.
+  BookToC = true
+
+  # (Optional, default none) Set the path to a logo for the book. If the logo is
+  # /static/logo.png then the path would be 'logo.png'
+  #BookLogo = 'logo.png'
+
+  # (Optional, default none) Set leaf bundle to render as side menu
+  # When not specified file structure and weights will be used
+  #BookMenuBundle = '/menu'
+
+  # (Optional, default docs) Specify section of content to render as menu
+  # You can also set value to "*" to render all sections to menu
+  BookSection = '*'
+
+  # Set source repository location.
+  # Used for 'Last Modified' and 'Edit this page' links.
+  BookRepo = 'https://github.com/abhimanyu003/sttr'
+
+  # Enable 'Edit this page' links for 'doc' page type.
+  # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
+  # Path must point to the site directory.
+  #BookEditPath = 'edit/master/exampleSite'
+
+  # (Optional, default January 2, 2006) Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  BookDateFormat = 'Jan 2, 2006'
+
+  # (Optional, default true) Enables search function with flexsearch,
+  # Index is built on fly, therefore it might slowdown your website.
+  # Configuration for indexing can be adjusted in i18n folder per language.
+  BookSearch = true
+
+  # (Optional, default true) Enables comments template on pages
+  # By default partials/docs/comments.html includes Disqus template
+  # See https://gohugo.io/content-management/comments/#configure-disqus
+  # Can be overwritten by same param in page frontmatter
+  #BookComments = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
+  # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
+  # Theme will print warning if page referenced in markdown does not exists.
+  #BookPortableLinks = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
+  #BookServiceWorker = true

hugo/content/cli/_index.md

@@ -0,0 +1,5 @@
+---
+weight: 100
+title: CLI Reference
+bookCollapseSection: true
+---

hugo/content/install/_index.md

@@ -0,0 +1,34 @@
+---
+weight: 1
+title: Install
+---
+
+# Installing sttr
+
+#### Quick install
+
+You can run the below `curl` to install it somewhere in your PATH for easy use.
+Ideally it will be installed at `./bin` folder
+
+```
+curl -sfL https://raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
+```
+
+#### Homebrew
+
+If you are on macOS and using Homebrew, you can install `sttr` with the following:
+
+```
+brew tap abhimanyu003/sttr
+brew install sttr
+```
+
+#### Go 
+
+```
+go install github.com/abhimanyu003/sttr@latest
+```
+
+#### Manually
+
+Download the pre-compiled binaries from the [Release!](https://github.com/abhimanyu003/sttr/releases) page and copy them to the desired location.