Init repo with first set of customisations
This commit is contained in:
parent
22a596e865
commit
90709d56d4
28 changed files with 489 additions and 4 deletions
5
.gitignore
vendored
5
.gitignore
vendored
|
|
@ -1 +1,4 @@
|
|||
/.idea
|
||||
public
|
||||
resources
|
||||
.hugo_build.lock
|
||||
.idea
|
||||
|
|
|
|||
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
[submodule "themes/hugo-theme-stack"]
|
||||
path = themes/hugo-theme-stack
|
||||
url = https://github.com/CaiJimmy/hugo-theme-stack/
|
||||
70
README.md
70
README.md
|
|
@ -1,5 +1,69 @@
|
|||
# cheesy-guacamole
|
||||
<img align="right" width="150" alt="logo" src="https://user-images.githubusercontent.com/5889006/190859553-5b229b4f-c476-4cbd-928f-890f5265ca4c.png">
|
||||
|
||||
Name comes from my first auto-generated repository on Github.
|
||||
# Hugo Theme Stack Starter Template
|
||||
|
||||
Always wanted to start a tech blog and now I might have some experience to talk about my setup and other topics i'm interested in!
|
||||
This is a quick start template for [Hugo theme Stack](https://github.com/CaiJimmy/hugo-theme-stack). It uses [Hugo modules](https://gohugo.io/hugo-modules/) feature to load the theme.
|
||||
|
||||
It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the theme to a public GitHub page automatically. Also, there's a cron job to update the theme automatically everyday.
|
||||
|
||||
## Get started
|
||||
|
||||
1. Click *Use this template*, and create your repository as `<username>.github.io` on GitHub.
|
||||

|
||||
|
||||
2. Once the repository is created, create a GitHub codespace associated with it.
|
||||

|
||||
|
||||
3. And voila! You're ready to go. The codespace has been configured with the latest version of Hugo extended, just run `hugo server` in the terminal and see your new site in action.
|
||||
|
||||
4. Check `config` folder for the configuration files. You can edit them to suit your needs. Make sure to update the `baseurl` property in `config/_default/config.toml` to your site's URL.
|
||||
|
||||
5. Open Settings -> Pages. Change the build branch from `master` to `gh-pages`.
|
||||

|
||||
|
||||
6. Once you're done editing the site, just commit it and push it. GitHub action will deploy the site automatically to GitHub page asociated with the repository.
|
||||

|
||||
|
||||
---
|
||||
|
||||
In case you don't want to use GitHub codespace, you can also run this template in your local machine. **You need to install Git, Go and Hugo extended locally.**
|
||||
|
||||
## Update theme manually
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
hugo mod get -u github.com/CaiJimmy/hugo-theme-stack/v3
|
||||
hugo mod tidy
|
||||
```
|
||||
|
||||
> This starter template has been configured with `v3` version of theme. Due to the limitation of Go module, once the `v4` or up version of theme is released, you need to update the theme manually. (Modifying `config/module.toml` file)
|
||||
|
||||
## Deploy to another static page hostings
|
||||
|
||||
If you want to build this site using another static page hosting, you need to make sure they have Go installed in the machine.
|
||||
|
||||
<details>
|
||||
<summary>Vercel</summary>
|
||||
|
||||
You need to overwrite build command to install manually Go:
|
||||
|
||||
```
|
||||
amazon-linux-extras install golang1.11 && hugo --gc --minify
|
||||
```
|
||||
|
||||

|
||||
|
||||
If you are using Node.js 20, you need to overwrite the install command to install manually Go:
|
||||
|
||||
```
|
||||
dnf install -y golang
|
||||
```
|
||||
|
||||

|
||||
|
||||
|
||||
Make sure also to specify Hugo version in the environment variable `HUGO_VERSION` (Use the latest version of Hugo extended):
|
||||
|
||||

|
||||
</details>
|
||||
|
|
|
|||
5
archetypes/default.md
Normal file
5
archetypes/default.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
+++
|
||||
date = '{{ .Date }}'
|
||||
draft = true
|
||||
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||
+++
|
||||
BIN
assets/img/avatar.jpeg
Executable file
BIN
assets/img/avatar.jpeg
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 113 KiB |
10
assets/jsconfig.json
Normal file
10
assets/jsconfig.json
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"*": [
|
||||
"../themes/hugo-theme-stack/assets/*"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
3
assets/scss/custom.scss
Normal file
3
assets/scss/custom.scss
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
/*
|
||||
You can add your own custom styles here.
|
||||
*/
|
||||
6
config/_default/_languages.toml
Normal file
6
config/_default/_languages.toml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Rename this file to languages.toml to enable multilingual support
|
||||
[en]
|
||||
languageName = "English"
|
||||
languagedirection = "ltr"
|
||||
title = ""
|
||||
weight = 1
|
||||
18
config/_default/config.toml
Normal file
18
config/_default/config.toml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# Change baseurl before deploy
|
||||
#baseurl = "https://blog.octubre.be"
|
||||
#languageCode = "en-us"
|
||||
#title = "Octubre"
|
||||
|
||||
# Theme i18n support
|
||||
# Available values: en, fr, id, ja, ko, pt-br, zh-cn, zh-tw, es, de, nl, it, th, el, uk, ar
|
||||
defaultContentLanguage = "en"
|
||||
|
||||
# Set hasCJKLanguage to true if DefaultContentLanguage is in [zh-cn ja ko]
|
||||
# This will make .Summary and .WordCount behave correctly for CJK languages.
|
||||
hasCJKLanguage = false
|
||||
|
||||
# Change it to your Disqus shortname before using
|
||||
disqusShortname = "hugo-theme-stack"
|
||||
|
||||
[pagination]
|
||||
pagerSize = 5
|
||||
4
config/_default/hugo.toml
Normal file
4
config/_default/hugo.toml
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
baseURL = 'https://blog.octubre.be'
|
||||
languageCode = 'en-us'
|
||||
title = 'Octubre'
|
||||
theme = 'hugo-theme-stack'
|
||||
26
config/_default/markup.toml
Normal file
26
config/_default/markup.toml
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# Markdown renderer configuration
|
||||
[goldmark.renderer]
|
||||
unsafe = true
|
||||
|
||||
[goldmark.extensions.passthrough]
|
||||
enable = true
|
||||
|
||||
# LaTeX math support
|
||||
# https://gohugo.io/content-management/mathematics/
|
||||
[goldmark.extensions.passthrough.delimiters]
|
||||
block = [['\[', '\]'], ['$$', '$$']]
|
||||
inline = [['\(', '\)']]
|
||||
|
||||
[tableOfContents]
|
||||
endLevel = 4
|
||||
ordered = true
|
||||
startLevel = 2
|
||||
|
||||
[highlight]
|
||||
noClasses = false
|
||||
codeFences = true
|
||||
guessSyntax = true
|
||||
lineNoStart = 1
|
||||
lineNos = true
|
||||
lineNumbersInTable = true
|
||||
tabWidth = 4
|
||||
24
config/_default/menu.toml
Normal file
24
config/_default/menu.toml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Configure main menu and social menu
|
||||
#[[main]]
|
||||
#identifier = "home"
|
||||
#name = "Home"
|
||||
#url = "/"
|
||||
#[main.params]
|
||||
#icon = "home"
|
||||
#newtab = true
|
||||
|
||||
[[social]]
|
||||
identifier = "github"
|
||||
name = "GitHub"
|
||||
url = "https://github.com/JeCheeseSmith"
|
||||
|
||||
[social.params]
|
||||
icon = "brand-github"
|
||||
|
||||
#[[social]]
|
||||
#identifier = "twitter"
|
||||
#name = "Twitter"
|
||||
#url = "https://twitter.com"
|
||||
#
|
||||
#[social.params]
|
||||
#icon = "brand-twitter"
|
||||
2
config/_default/module.toml
Normal file
2
config/_default/module.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
#[[imports]]
|
||||
#path = "github.com/CaiJimmy/hugo-theme-stack/v3"
|
||||
150
config/_default/params.toml
Normal file
150
config/_default/params.toml
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
# Pages placed under these sections will be shown on homepage and archive page.
|
||||
mainSections = ["post"]
|
||||
# Output page's full content in RSS.
|
||||
rssFullContent = true
|
||||
favicon = "/favicon.png"
|
||||
|
||||
[footer]
|
||||
since = 2020
|
||||
customText = ""
|
||||
|
||||
[dateFormat]
|
||||
published = "Jan 02, 2006"
|
||||
lastUpdated = "Jan 02, 2006 15:04 MST"
|
||||
|
||||
[sidebar]
|
||||
emoji = "✉️"
|
||||
subtitle = "Words can't describe"
|
||||
|
||||
[sidebar.avatar]
|
||||
enabled = true
|
||||
local = true
|
||||
src = "img/avatar.jpeg"
|
||||
|
||||
[article]
|
||||
headingAnchor = false
|
||||
math = false
|
||||
readingTime = true
|
||||
|
||||
[article.license]
|
||||
enabled = true
|
||||
default = "Licensed under CC BY-NC-SA 4.0"
|
||||
|
||||
## Widgets
|
||||
[[widgets.homepage]]
|
||||
type = "search"
|
||||
|
||||
[[widgets.homepage]]
|
||||
type = "archives"
|
||||
|
||||
[widgets.homepage.params]
|
||||
limit = 5
|
||||
|
||||
[[widgets.homepage]]
|
||||
type = "categories"
|
||||
|
||||
[widgets.homepage.params]
|
||||
limit = 10
|
||||
|
||||
[[widgets.homepage]]
|
||||
type = "tag-cloud"
|
||||
|
||||
[widgets.homepage.params]
|
||||
limit = 10
|
||||
|
||||
[[widgets.page]]
|
||||
type = "toc"
|
||||
|
||||
[opengraph.twitter]
|
||||
site = ""
|
||||
card = "summary_large_image"
|
||||
|
||||
[defaultImage.opengraph]
|
||||
enabled = false
|
||||
local = false
|
||||
src = ""
|
||||
|
||||
[colorScheme]
|
||||
toggle = true
|
||||
default = "auto"
|
||||
|
||||
[imageProcessing.cover]
|
||||
enabled = true
|
||||
|
||||
[imageProcessing.content]
|
||||
enabled = true
|
||||
|
||||
## Comments
|
||||
[comments]
|
||||
enabled = false
|
||||
provider = "disqus"
|
||||
|
||||
[comments.disqusjs]
|
||||
shortname = ""
|
||||
apiUrl = ""
|
||||
apiKey = ""
|
||||
admin = ""
|
||||
adminLabel = ""
|
||||
|
||||
[comments.utterances]
|
||||
repo = ""
|
||||
issueTerm = "pathname"
|
||||
label = ""
|
||||
|
||||
[comments.remark42]
|
||||
host = ""
|
||||
site = ""
|
||||
locale = ""
|
||||
|
||||
[comments.vssue]
|
||||
platform = ""
|
||||
owner = ""
|
||||
repo = ""
|
||||
clientId = ""
|
||||
clientSecret = ""
|
||||
autoCreateIssue = false
|
||||
|
||||
[comments.waline]
|
||||
serverURL = ""
|
||||
lang = ""
|
||||
visitor = ""
|
||||
avatar = ""
|
||||
emoji = ["https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo"]
|
||||
requiredMeta = ["name", "email", "url"]
|
||||
placeholder = ""
|
||||
|
||||
[comments.waline.locale]
|
||||
admin = "Admin"
|
||||
|
||||
[comments.twikoo]
|
||||
envId = ""
|
||||
region = ""
|
||||
path = ""
|
||||
lang = ""
|
||||
|
||||
[comments.cactus]
|
||||
defaultHomeserverUrl = "https://matrix.cactus.chat:8448"
|
||||
serverName = "cactus.chat"
|
||||
siteName = ""
|
||||
|
||||
[comments.giscus]
|
||||
repo = ""
|
||||
repoID = ""
|
||||
category = ""
|
||||
categoryID = ""
|
||||
mapping = ""
|
||||
lightTheme = ""
|
||||
darkTheme = ""
|
||||
reactionsEnabled = 1
|
||||
emitMetadata = 0
|
||||
|
||||
[comments.gitalk]
|
||||
owner = ""
|
||||
admin = ""
|
||||
repo = ""
|
||||
clientID = ""
|
||||
clientSecret = ""
|
||||
|
||||
[comments.cusdis]
|
||||
host = ""
|
||||
id = ""
|
||||
3
config/_default/permalinks.toml
Normal file
3
config/_default/permalinks.toml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Permalinks format of each content section
|
||||
post = "/p/:slug/"
|
||||
page = "/:slug/"
|
||||
12
config/_default/related.toml
Normal file
12
config/_default/related.toml
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# Related contents configuration
|
||||
includeNewer = true
|
||||
threshold = 60
|
||||
toLower = false
|
||||
|
||||
[[indices]]
|
||||
name = "tags"
|
||||
weight = 100
|
||||
|
||||
[[indices]]
|
||||
name = "categories"
|
||||
weight = 200
|
||||
8
content/_index.md
Normal file
8
content/_index.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
menu:
|
||||
main:
|
||||
name: Home
|
||||
weight: 1
|
||||
params:
|
||||
icon: home
|
||||
---
|
||||
10
content/categories/announcements/_index.md
Normal file
10
content/categories/announcements/_index.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Announcements
|
||||
description: aaa
|
||||
image:
|
||||
|
||||
# Badge style
|
||||
style:
|
||||
background: "#2a9d8f"
|
||||
color: "#fff"
|
||||
---
|
||||
10
content/categories/guides/_index.md
Normal file
10
content/categories/guides/_index.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Guides
|
||||
description: Tutorials for various topics
|
||||
image:
|
||||
|
||||
# Badge style
|
||||
style:
|
||||
background: "#2a9d8f"
|
||||
color: "#fff"
|
||||
---
|
||||
10
content/categories/opinion/_index.md
Normal file
10
content/categories/opinion/_index.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Opinion & Vision
|
||||
description:
|
||||
image:
|
||||
|
||||
# Badge style
|
||||
style:
|
||||
background: "#2a9d8f"
|
||||
color: "#fff"
|
||||
---
|
||||
11
content/page/archives/index.md
Normal file
11
content/page/archives/index.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: "Archives"
|
||||
date: 2022-03-06
|
||||
layout: "archives"
|
||||
slug: "archives"
|
||||
menu:
|
||||
main:
|
||||
weight: 2
|
||||
params:
|
||||
icon: archives
|
||||
---
|
||||
46
content/page/links/index.md
Normal file
46
content/page/links/index.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: Links
|
||||
links:
|
||||
- title: Octubre
|
||||
description: Octubre is the name for my hobby project in which I self host & maintain different services, including this blog!
|
||||
website: https://octubre.be
|
||||
image: https://octubre.be/favicon.png
|
||||
menu:
|
||||
main:
|
||||
weight: 4
|
||||
params:
|
||||
icon: link
|
||||
|
||||
comments: false
|
||||
---
|
||||
|
||||
[//]: # (To use this feature, add `links` section to frontmatter.)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (This page's frontmatter:)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (```yaml)
|
||||
|
||||
[//]: # (links:)
|
||||
|
||||
[//]: # ( - title: GitHub)
|
||||
|
||||
[//]: # ( description: GitHub is the world's largest software development platform.)
|
||||
|
||||
[//]: # ( website: https://github.com)
|
||||
|
||||
[//]: # ( image: https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
|
||||
|
||||
[//]: # ( - title: TypeScript)
|
||||
|
||||
[//]: # ( description: TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.)
|
||||
|
||||
[//]: # ( website: https://www.typescriptlang.org)
|
||||
|
||||
[//]: # ( image: ts-logo-128.jpg)
|
||||
|
||||
[//]: # (```)
|
||||
|
||||
[//]: # ()
|
||||
[//]: # (`image` field accepts both local and external images.)
|
||||
13
content/page/search/index.md
Normal file
13
content/page/search/index.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: "Search"
|
||||
slug: "search"
|
||||
layout: "search"
|
||||
outputs:
|
||||
- html
|
||||
- json
|
||||
menu:
|
||||
main:
|
||||
weight: 3
|
||||
params:
|
||||
icon: search
|
||||
---
|
||||
BIN
content/post/hello-world/cover.jpg
Normal file
BIN
content/post/hello-world/cover.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
20
content/post/hello-world/index.md
Normal file
20
content/post/hello-world/index.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Hello World
|
||||
description: Welcome to Hugo Theme Stack
|
||||
slug: hello-world
|
||||
date: 2022-03-06 00:00:00+0000
|
||||
image: cover.jpg
|
||||
categories:
|
||||
- Announcements
|
||||
tags:
|
||||
- Launch
|
||||
weight: 1 # You can add weight to some posts to override the default sorting (date descending)
|
||||
---
|
||||
|
||||
Welcome to Hugo theme Stack. This is your first post. Edit or delete it, then start writing!
|
||||
|
||||
For more information about this theme, check the documentation: https://stack.jimmycai.com/
|
||||
|
||||
Want a site like this? Check out [hugo-theme-stack-stater](https://github.com/CaiJimmy/hugo-theme-stack-starter)
|
||||
|
||||
> Photo by [Pawel Czerwinski](https://unsplash.com/@pawel_czerwinski) on [Unsplash](https://unsplash.com/)
|
||||
23
layouts/partials/footer/footer.html
Normal file
23
layouts/partials/footer/footer.html
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
{{- $ThemeVersion := "3.30.0" -}}
|
||||
<footer class="site-footer">
|
||||
<section class="copyright">
|
||||
©
|
||||
<!-- {{ if and (.Site.Params.footer.since) (ne .Site.Params.footer.since (int (now.Format "2006"))) }}-->
|
||||
<!-- {{ .Site.Params.footer.since }} - -->
|
||||
<!-- {{ end }}-->
|
||||
{{ now.Format "2006" }} {{ default .Site.Title .Site.Copyright }}
|
||||
</section>
|
||||
|
||||
<section class="powerby">
|
||||
{{ with .Site.Params.footer.customText }}
|
||||
{{ . | safeHTML }} <br/>
|
||||
{{ end }}
|
||||
|
||||
{{- $Generator := `<a href="https://gohugo.io/" target="_blank" rel="noopener">Hugo</a>` -}}
|
||||
{{- $Theme := printf `<b><a href="https://github.com/CaiJimmy/hugo-theme-stack" target="_blank" rel="noopener" data-version="%s">Stack</a></b>` $ThemeVersion -}}
|
||||
{{- $DesignedBy := `<a href="https://jimmycai.com" target="_blank" rel="noopener">Jimmy</a>` -}}
|
||||
|
||||
{{ T "footer.builtWith" (dict "Generator" $Generator) | safeHTML }} <br />
|
||||
{{ T "footer.designedBy" (dict "Theme" $Theme "DesignedBy" $DesignedBy) | safeHTML }}
|
||||
</section>
|
||||
</footer>
|
||||
BIN
static/favicon.png
Normal file
BIN
static/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
1
themes/hugo-theme-stack
Submodule
1
themes/hugo-theme-stack
Submodule
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 47832083d8669f7269a6a301f79eb44247a9a5d0
|
||||
Loading…
Add table
Add a link
Reference in a new issue