From d7fecefecfca46e13790053495f25ad50a44e418 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20Alvari=C3=B1o?= Date: Sun, 31 Dec 2023 10:39:39 +0100 Subject: [PATCH] Initial commit --- .github/dependabot.yml | 25 + .github/workflows/deploy.yml | 43 ++ .github/workflows/update-theme.yml | 28 + .gitignore | 6 + .gitmodules | 3 + LICENSE | 21 + README.en.md | 94 ++++ README.md | 94 ++++ archetypes/default.md | 8 + config/_default/author.toml | 8 + config/_default/config.toml | 19 + config/_default/frontmatter.toml | 6 + config/_default/markup.toml | 43 ++ config/_default/mediaTypes.toml | 11 + config/_default/menus.toml | 46 ++ config/_default/outputFormats.toml | 16 + config/_default/outputs.toml | 11 + config/_default/params.toml | 786 +++++++++++++++++++++++++++++ config/_default/permalinks.toml | 8 + config/_default/privacy.toml | 9 + config/_default/sitemap.toml | 8 + content/posts/hello-world.md | 89 ++++ package.json | 22 + static/CNAME | 1 + themes/FixIt | 1 + 25 files changed, 1406 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/deploy.yml create mode 100644 .github/workflows/update-theme.yml create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 LICENSE create mode 100644 README.en.md create mode 100644 README.md create mode 100644 archetypes/default.md create mode 100644 config/_default/author.toml create mode 100644 config/_default/config.toml create mode 100644 config/_default/frontmatter.toml create mode 100644 config/_default/markup.toml create mode 100644 config/_default/mediaTypes.toml create mode 100644 config/_default/menus.toml create mode 100644 config/_default/outputFormats.toml create mode 100644 config/_default/outputs.toml create mode 100644 config/_default/params.toml create mode 100644 config/_default/permalinks.toml create mode 100644 config/_default/privacy.toml create mode 100644 config/_default/sitemap.toml create mode 100644 content/posts/hello-world.md create mode 100644 package.json create mode 100644 static/CNAME create mode 160000 themes/FixIt diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..d550813 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,25 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" + open-pull-requests-limit: 1000 + assignees: + - "Lruihao" + labels: + - "dependencies" + - package-ecosystem: "gitsubmodule" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "monthly" + open-pull-requests-limit: 1000 + assignees: + - "Lruihao" + labels: + - "dependencies" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..763ad3a --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,43 @@ +name: Hugo build and deploy +on: + push: + branches: [ main ] + paths: + - 'assets/**' + - 'config/**' + - 'content/**' + - 'data/**' + - 'static/**' + - 'themes/**' + workflow_run: + workflows: ['Update theme'] + types: + - completed + workflow_dispatch: +jobs: + Actions-Hugo-Deploy: + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + with: + submodules: true # Fetch Hugo themes (true OR recursive) + fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: latest + extended: true + + - name: Build + run: hugo -v --gc --minify + + - name: Deploy to Github Pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + # See https://github.com/JamesIves/github-pages-deploy-action#configuration- + branch: gh-pages + folder: public + clean: true + single-commit: true diff --git a/.github/workflows/update-theme.yml b/.github/workflows/update-theme.yml new file mode 100644 index 0000000..7c41c03 --- /dev/null +++ b/.github/workflows/update-theme.yml @@ -0,0 +1,28 @@ +name: Update theme + +# Controls when the workflow will run +on: + schedule: + # Update theme automatically everyday at 00:00 UTC + - cron: "0 0 * * *" + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + Update-FixIt: + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + with: + submodules: true + fetch-depth: 0 + + - name: Update theme + run: git submodule update --remote --merge themes/FixIt + + - name: Commit changes + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: ':arrow_up: Chore(theme): update FixIt version' + commit_author: 'github-actions[bot] ' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b9c04d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +node_modules/ +build/ +public/ +resources/ + +.hugo_build.lock diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..de274c0 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "themes/FixIt"] + path = themes/FixIt + url = https://github.com/hugo-fixit/FixIt.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cc89302 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021-2022 FIXIT.LRUIHAO.CN + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..de9dd85 --- /dev/null +++ b/README.en.md @@ -0,0 +1,94 @@ +# Hugo FixIt Blog Template (Git) + +👉 English | [简体中文](README.md) + +This is a quick start template for Hugo theme [FixIt](https://github.com/hugo-fixit/FixIt). It uses [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) feature to load the theme. + +It comes with a basic theme structure and configuration. GitHub action has been set up to deploy the blog to a public GitHub page automatically. Also, there's a cron job to update the theme automatically everyday. + +## Directory structure + +```bash +▸ .github/ # GitHub configuration +▸ archetypes/ # page archetypes (like scaffolds of archetypes) +▸ assets/ # css, js, third-party libraries etc. +▸ config/ # configuration files +▸ content/ # markdown files for hugo project +▸ data/ # blog data (allow: yaml, json, toml), e.g. friends.yml +▸ public/ # build directory +▸ static/ # static files, e.g. favicon.ico +▸ themes/ # theme submodules +``` + +## Quick Start + +For a complete quick start, see this [page](https://fixit.lruihao.cn/documentation/getting-started/). + +### Prerequisites + +[Hugo](https://gohugo.io/installation/): >= 0.109.0 (extended version) + +### Use this Template + +1. Click **Use this template**, and create your repository on GitHub. + + image + +2. Once the repository is created, just clone and enjoy it! + + ```bash + # Clone with your own repository url + git clone --recursive https://github.com//.git + ``` + +### Launching the Site + +```bash +# Development environment +hugo server +# Production environment +hugo server -e production +``` + +### Build the Site + +When your site is ready to deploy, run the following command: + +```bash +hugo +``` + +### Update theme + +Afterwards you can upgrade the theme with the following command: + +```bash +# Update theme manually +git submodule update --remote --merge themes/FixIt +``` + +
+ Start via NPM script + + ```bash + npm install + # build the blog + npm run build + # run a local debugging server with watch + npm run server + # run a local debugging server in production environment + npm run server:production + # update theme submodules + npm run update:theme + ``` + +
+ +## Troubleshooting + +
+ remote: Permission to git denied to github-actions[bot]. + Head to Setting => Actions => General => Workflow permissions => Check "Read and write permissions". +
+ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..8bf89d0 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +# Hugo FixIt 博客模板（Git） + +👉 中文 | [English](README.en.md) + +这是一个用于 Hugo 主题 [FixIt](https://github.com/hugo-fixit/FixIt) 的快速入门模板。它使用 [Git 子模块](https://git-scm.com/book/en/v2/Git-Tools-Submodules) 功能来加载主题。 + +它提供了基本的主题结构和配置。已经设置了 GitHub Actions，可以自动部署博客到 GitHub Pages。此外，还有一个定时任务，每天自动更新主题。 + +## 目录结构 + +```bash +▸ .github/ # GitHub configuration +▸ archetypes/ # page archetypes (like scaffolds of archetypes) +▸ assets/ # css, js, third-party libraries etc. +▸ config/ # configuration files +▸ content/ # markdown files for hugo project +▸ data/ # blog data (allow: yaml, json, toml), e.g. friends.yml +▸ public/ # build directory +▸ static/ # static files, e.g. favicon.ico +▸ themes/ # theme submodules +``` + +## 快速入门 + +完整的快速入门请参阅此 [页面](https://fixit.lruihao.cn/documentation/getting-started/)。 + +### 准备 + +[Hugo](https://gohugo.io/installation/): >= 0.109.0 (extended version) + +### 使用此模板 + +1. 点击 **Use this template**，在 GitHub 上创建你的仓库。 + + image + +2. 仓库创建后，只需克隆并开始使用！ + + ```bash + # 使用你自己的仓库 URL 进行克隆 + git clone --recursive https://github.com//.git + ``` + +### 启动站点 + +```bash +# 开发环境 +hugo server +# 生产环境 +hugo server -e production +``` + +### 构建站点 + +当你的站点准备部署时，运行以下命令： + +```bash +hugo +``` + +### 更新主题 + +之后，你可以使用以下命令升级主题： + +```bash +# 手动更新主题 +git submodule update --remote --merge themes/FixIt +``` + +
+ 通过 NPM 脚本启动 + + ```bash + npm install + # 构建博客 + npm run build + # 运行带有监视的本地调试服务器 + npm run server + # 在生产环境中运行本地调试服务器 + npm run server:production + # 更新主题子模块 + npm run update:theme + ``` + +
+ +## 故障排除 + +
+ remote: Permission to git denied to github-actions[bot]. + 转到 Setting => Actions => General => Workflow permissions => 选中 "Read and write permissions"。 +
+ + diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..cb8a714 --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,8 @@ +--- +title: "{{ replace .TranslationBaseName "-" " " | title }}" +subtitle: "" +date: {{ .Date }} +description: "" +keywords: "" +comment: false +--- diff --git a/config/_default/author.toml b/config/_default/author.toml new file mode 100644 index 0000000..30681e2 --- /dev/null +++ b/config/_default/author.toml @@ -0,0 +1,8 @@ +# ------------------------------------------------------------------------------------- +# Author Configuration +# ------------------------------------------------------------------------------------- + +name = "Lruihao" +email = "1024@lruihao.cn" +link = "https://github.com/Lruihao" +avatar = "" diff --git a/config/_default/config.toml b/config/_default/config.toml new file mode 100644 index 0000000..ecf061e --- /dev/null +++ b/config/_default/config.toml @@ -0,0 +1,19 @@ +# ------------------------------------------------------------------------------------- +# Hugo Configuration +# See: https://gohugo.io/getting-started/configuration/ +# ------------------------------------------------------------------------------------- + +title = "Hugo FixIt Blog" +baseURL = "http://example.org/" +theme = "FixIt" +defaultContentLanguage = "en" +languageCode = "en" +hasCJKLanguage = true +enableRobotsTXT = true +enableEmoji = true +enableGitInfo = true +relativeURLs = false +buildDrafts = false +summaryLength = 150 +# ignore some build errors +ignoreErrors = ["error-remote-getjson", "error-missing-instagram-accesstoken"] diff --git a/config/_default/frontmatter.toml b/config/_default/frontmatter.toml new file mode 100644 index 0000000..8f85808 --- /dev/null +++ b/config/_default/frontmatter.toml @@ -0,0 +1,6 @@ +# ------------------------------------------------------------------------------------- +# Front Matter Configuration +# See: https://gohugo.io/getting-started/configuration/#configure-front-matter +# ------------------------------------------------------------------------------------- + +lastmod = ["lastmod", ":git", ":fileModTime", ":defalut"] diff --git a/config/_default/markup.toml b/config/_default/markup.toml new file mode 100644 index 0000000..a994cf8 --- /dev/null +++ b/config/_default/markup.toml @@ -0,0 +1,43 @@ +# ------------------------------------------------------------------------------------- +# Markup related configuration in Hugo +# See: https://gohugo.io/getting-started/configuration-markup/ +# ------------------------------------------------------------------------------------- + +# Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting) +[highlight] + ########## necessary configurations ########## + # https://github.com/Lruihao/FixIt/issues/43 + codeFences = true + lineNos = true + lineNumbersInTable = true + noClasses = false + ########## necessary configurations ########## + guessSyntax = true + +# Goldmark is from Hugo 0.60 the default library used for Markdown +[goldmark] + [goldmark.extensions] + definitionList = true + footnote = true + linkify = true + strikethrough = true + table = true + taskList = true + typographer = true + [goldmark.parser] + autoHeadingID = true + autoHeadingIDType = "github" + wrapStandAloneImageWithinParagraph = true + [goldmark.parser.attribute] + block = true + title = true + [goldmark.renderer] + # By default, Goldmark ignores newlines within a paragraph. Set to true to render newlines as
elements. + hardWraps = false + # whether to use HTML tags directly in the document + unsafe = true + +# Table Of Contents settings +[tableOfContents] + startLevel = 2 + endLevel = 6 diff --git a/config/_default/mediaTypes.toml b/config/_default/mediaTypes.toml new file mode 100644 index 0000000..c59a958 --- /dev/null +++ b/config/_default/mediaTypes.toml @@ -0,0 +1,11 @@ +# ------------------------------------------------------------------------------------- +# Media Types +# See: https://gohugo.io/templates/output-formats/#media-types +# ------------------------------------------------------------------------------------- + +# Options to make output .md files +["text/markdown"] + suffixes = ["md"] +# Options to make output .txt files +["text/plain"] + suffixes = ["txt"] diff --git a/config/_default/menus.toml b/config/_default/menus.toml new file mode 100644 index 0000000..5a3d85a --- /dev/null +++ b/config/_default/menus.toml @@ -0,0 +1,46 @@ +# ------------------------------------------------------------------------------------- +# Menu Configuration +# See: https://fixit.lruihao.cn/theme-documentation-basics/#menu-advanced-configuration +# ------------------------------------------------------------------------------------- + +[[main]] + identifier = "posts" + # you can add extra information before the name (HTML format is supported), such as icons + pre = "" + # you can add extra information after the name (HTML format is supported), such as icons + post = "" + name = "Posts" + url = "/posts/" + # title will be shown when you hover on this menu link + title = "" + weight = 1 + # FixIt 0.2.14 | NEW add user-defined content to menu items + [main.params] + # add css class to a specific menu item + class = "" + # whether set as a draft menu item whose function is similar to a draft post/page + draft = false + # FixIt 0.2.16 | NEW add fontawesome icon to a specific menu item + icon = "fa-solid fa-archive" + # FixIt 0.2.16 | NEW set menu item type, optional values: ["mobile", "desktop"] + type = "" +[[main]] + identifier = "categories" + pre = "" + post = "" + name = "Categories" + url = "/categories/" + title = "" + weight = 2 + [main.params] + icon = "fa-solid fa-th" +[[main]] + identifier = "tags" + pre = "" + post = "" + name = "Tags" + url = "/tags/" + title = "" + weight = 3 + [main.params] + icon = "fa-solid fa-tags" diff --git a/config/_default/outputFormats.toml b/config/_default/outputFormats.toml new file mode 100644 index 0000000..4353b24 --- /dev/null +++ b/config/_default/outputFormats.toml @@ -0,0 +1,16 @@ +# ------------------------------------------------------------------------------------- +# Output Format Definitions +# See: https://gohugo.io/templates/output-formats/#output-format-definitions +# ------------------------------------------------------------------------------------- + +# Options to make output .md files +[MarkDown] + mediaType = "text/markdown" + isPlainText = true + isHTML = false +# Options to make output baidu_urls.txt file +[BaiduUrls] + baseName = "baidu_urls" + mediaType = "text/plain" + isPlainText = true + isHTML = false diff --git a/config/_default/outputs.toml b/config/_default/outputs.toml new file mode 100644 index 0000000..a28ad84 --- /dev/null +++ b/config/_default/outputs.toml @@ -0,0 +1,11 @@ +# ------------------------------------------------------------------------------------- +# Customizing Output Formats +# See: https://gohugo.io/templates/output-formats/#customizing-output-formats +# ------------------------------------------------------------------------------------- + +# Options to make hugo output files +home = ["HTML", "RSS", "JSON", "BaiduUrls"] +page = ["HTML", "MarkDown"] +section = ["HTML", "RSS"] +taxonomy = ["HTML"] +Term = ["HTML", "RSS"] diff --git a/config/_default/params.toml b/config/_default/params.toml new file mode 100644 index 0000000..7102c9d --- /dev/null +++ b/config/_default/params.toml @@ -0,0 +1,786 @@ +# ------------------------------------------------------------------------------------- +# Theme Core Configuration +# See: https://fixit.lruihao.cn/theme-documentation-basics/#site-configuration +# ------------------------------------------------------------------------------------- + +# FixIt 0.2.15 | CHANGED FixIt theme version +version = "0.2.X" # e.g. "0.2.X", "0.2.15", "v0.2.15" etc. +# site description +description = "This is my new Hugo FixIt site" +# site keywords +keywords = ["Hugo", "FixIt"] +# site default theme ["light", "dark", "auto"] +defaultTheme = "auto" +# public git repo url only then enableGitInfo is true +gitRepo = "" +# FixIt 0.1.1 | NEW which hash function used for SRI, when empty, no SRI is used +# ["sha256", "sha384", "sha512", "md5"] +fingerprint = "" +# FixIt 0.2.0 | NEW date format +dateFormat = "2006-01-02" +# website images for Open Graph and Twitter Cards +images = [] +# FixIt 0.2.12 | NEW enable PWA +enablePWA = false +# FixIt 0.2.14 | NEW whether to add external Icon for external links automatically +externalIcon = false +# FixIt 0.2.14 | NEW FixIt will, by default, inject a theme meta tag in the HTML head on the home page only. +# You can turn it off, but we would really appreciate if you don’t, as this is a good way to watch FixIt's popularity on the rise. +disableThemeInject = false + +# FixIt 0.2.0 | NEW App icon config +[app] + # optional site title override for the app when added to an iOS home screen or Android launcher + title = "Hugo FixIt Blog" + # whether to omit favicon resource links + noFavicon = false + # modern SVG favicon to use in place of older style .png and .ico files + svgFavicon = "" + # Safari mask icon color + iconColor = "#5bbad5" + # Windows v8-10 tile color + tileColor = "#da532c" + # FixIt 0.2.12 | CHANGED Android browser theme color + [app.themeColor] + light = "#f8f8f8" + dark = "#252627" + +# FixIt 0.2.0 | NEW Search config +[search] + enable = true + # type of search engine ["lunr", "algolia", "fuse"] + type = "lunr" + # max index length of the chunked content + contentLength = 4000 + # placeholder of the search bar + placeholder = "" + # FixIt 0.2.1 | NEW max number of results length + maxResultLength = 10 + # FixIt 0.2.3 | NEW snippet length of the result + snippetLength = 30 + # FixIt 0.2.1 | NEW HTML tag name of the highlight part in results + highlightTag = "em" + # FixIt 0.2.4 | NEW whether to use the absolute URL based on the baseURL in search index + absoluteURL = false + [search.algolia] + index = "" + appID = "" + searchKey = "" + [search.fuse] + # FixIt 0.2.17 | NEW https://fusejs.io/api/options.html + isCaseSensitive = false + minMatchCharLength = 2 + findAllMatches = false + location = 0 + threshold = 0.3 + distance = 100 + ignoreLocation = false + useExtendedSearch = false + ignoreFieldNorm = false + +# Header config +[header] + # FixIt 0.2.13 | CHANGED desktop header mode ["sticky", "normal", "auto"] + desktopMode = "sticky" + # FixIt 0.2.13 | CHANGED mobile header mode ["sticky", "normal", "auto"] + mobileMode = "auto" + # FixIt 0.2.0 | NEW Header title config + [header.title] + # URL of the LOGO + logo = "/fixit.min.svg" + # title name + name = "Hugo FixIt Blog" + # you can add extra information before the name (HTML format is supported), such as icons + pre = "" + # you can add extra information after the name (HTML format is supported), such as icons + post = "" + # FixIt 0.2.5 | NEW whether to use typeit animation for title name + typeit = false + # FixIt 0.2.12 | NEW Header subtitle config + [header.subtitle] + # subtitle name + name = "" + # whether to use typeit animation for subtitle name + typeit = false + +# FixIt 0.2.18 | NEW Breadcrumb config +[breadcrumb] + enable = false + sticky = false + showHome = false + +# Footer config +[footer] + enable = true + # FixIt 0.2.17 | CHANGED Custom content (HTML format is supported) + # For advanced use, see parameter `params.customFilePath.footer` + custom = "" + # FixIt 0.2.0 | NEW whether to show Hugo and theme info + hugo = true + # FixIt 0.2.0 | NEW whether to show copyright info + copyright = true + # FixIt 0.2.0 | NEW whether to show the author + author = true + # Site creation year + since = 2021 + # FixIt 0.2.14 | NEW whether to show total word count of site content + wordCount = true + # FixIt 0.2.12 | NEW Public network security only in China (HTML format is supported) + gov = "" + # ICP info only in China (HTML format is supported) + icp = "" + # license info (HTML format is supported) + license = 'CC BY-NC-SA 4.0' + # FixIt 0.2.17 | CHANGED Site creation time + [footer.siteTime] + enable = false + animate = true + icon = "fa-solid fa-heartbeat" + pre = "" + value = "" # e.g. "2021-12-18T16:15:22+08:00" + # FixIt 0.2.17 | NEW footer lines order, optional values: ["first", 0, 1, 2, 3, 4, 5, "last"] + [footer.order] + powered = 0 + copyright = 0 + statistics = 0 + visitor = 0 + beian = 0 + +# FixIt 0.2.0 | NEW Section (all posts) page config +[section] + # special amount of posts in each section page + paginate = 20 + # date format (month and day) + dateFormat = "01-02" + # amount of RSS pages + rss = 10 + # FixIt 0.2.13 | NEW recently updated posts settings + [section.recentlyUpdated] + enable = false + rss = false + days = 30 + maxCount = 10 + +# FixIt 0.2.0 | NEW List (category or tag) page config +[list] + # special amount of posts in each list page + paginate = 20 + # date format (month and day) + dateFormat = "01-02" + # amount of RSS pages + rss = 10 + +# FixIt 0.2.17 | NEW TagCloud config for tags page +[tagcloud] + enable = false + min = 14 # Minimum font size in px + max = 32 # Maximum font size in px + peakCount = 10 # Maximum count of posts per tag + orderby = "name" # Order of tags, optional values: ["name", "count"] + +# Home page config +[home] + # FixIt 0.2.0 | NEW amount of RSS pages + rss = 10 + # Home page profile + [home.profile] + enable = true + # Gravatar Email for preferred avatar in home page + gravatarEmail = "xx@xx.com" + # URL of avatar shown in home page + avatarURL = "" + # FixIt 0.2.17 | NEW identifier of avatar menu link + avatarMenu = "" + # FixIt 0.2.7 | CHANGED title shown in home page (HTML format is supported) + title = "" + # subtitle shown in home page + subtitle = "This is my new Hugo FixIt site" + # whether to use typeit animation for subtitle + typeit = true + # whether to show social links + social = true + # FixIt 0.2.0 | NEW disclaimer (HTML format is supported) + disclaimer = "" + # Home page posts + [home.posts] + enable = true + # special amount of posts in each home posts page + paginate = 6 + +# FixIt 0.2.16 | CHANGED Social config about the author +[social] + GitHub = "" + Linkedin = "" + Twitter = "" + Instagram = "" + Facebook = "" + Telegram = "" + Medium = "" + Gitlab = "" + Youtubelegacy = "" + Youtubecustom = "" + Youtubechannel = "" + Tumblr = "" + Quora = "" + Keybase = "" + Pinterest = "" + Reddit = "" + Codepen = "" + FreeCodeCamp = "" + Bitbucket = "" + Stackoverflow = "" + Weibo = "" + Odnoklassniki = "" + VK = "" + Flickr = "" + Xing = "" + Snapchat = "" + Soundcloud = "" + Spotify = "" + Bandcamp = "" + Paypal = "" + Fivehundredpx = "" + Mix = "" + Goodreads = "" + Lastfm = "" + Foursquare = "" + Hackernews = "" + Kickstarter = "" + Patreon = "" + Steam = "" + Twitch = "" + Strava = "" + Skype = "" + Whatsapp = "" + Zhihu = "" + Douban = "" + Angellist = "" + Slidershare = "" + Jsfiddle = "" + Deviantart = "" + Behance = "" + Dribbble = "" + Wordpress = "" + Vine = "" + Googlescholar = "" + Researchgate = "" + Mastodon = "" + Thingiverse = "" + Devto = "" + Gitea = "" + XMPP = "" + Matrix = "" + Bilibili = "" + ORCID = "" + Liberapay = "" + Ko-Fi = "" + BuyMeaCoffee = "" + Linktree = "" + QQ = "" + QQGroup = "" # https://qun.qq.com/join.html + Diaspora = "" + CSDN = "" + Discord = "" + DiscordInvite = "" + Lichess = "" + Pleroma = "" + Kaggle = "" + MediaWiki= "" + Plume = "" + HackTheBox = "" + RootMe = "" + Feishu = "" + TryHackMe = "" + Douyin = "" + TikTok = "" + Phone = "" + Email = "" + RSS = true + +# FixIt 0.2.0 | CHANGED Page config +[page] + # FixIt 0.2.18 | NEW whether to enable the author's avatar of the post + authorAvatar = true + # FixIt 0.2.0 | NEW whether to hide a page from home page + hiddenFromHomePage = false + # FixIt 0.2.0 | NEW whether to hide a page from search results + hiddenFromSearch = false + # FixIt 0.2.0 | NEW whether to enable twemoji + twemoji = false + # whether to enable lightgallery + # FixIt 0.2.18 | CHANGED if set to "force", images in the content will be forced to shown as the gallery. + lightgallery = false + # FixIt 0.2.0 | NEW whether to enable the ruby extended syntax + ruby = true + # FixIt 0.2.0 | NEW whether to enable the fraction extended syntax + fraction = true + # FixIt 0.2.0 | NEW whether to enable the fontawesome extended syntax + fontawesome = true + # license info (HTML format is supported) + license = 'CC BY-NC-SA 4.0' + # whether to show link to Raw Markdown content of the content + linkToMarkdown = true + # FixIt 0.2.4 | NEW whether to show the full text content in RSS + rssFullText = false + # FixIt 0.2.13 | NEW Page style ["narrow", "normal", "wide", ...] + pageStyle = "normal" + # FixIt 0.2.17 | CHANGED Auto Bookmark Support + # If true, save the reading progress when closing the page. + autoBookmark = false + # FixIt 0.2.17 | NEW whether to enable wordCount + wordCount = true + # FixIt 0.2.17 | NEW whether to enable readingTime + readingTime = true + # FixIt 0.2.17 | NEW end of post flag + endFlag = "" + # FixIt 0.2.18 | NEW whether to enable instant.page + instantPage = false + + # FixIt 0.2.15 | NEW Repost config + [page.repost] + enable = false + url = "" + # FixIt 0.2.0 | NEW Table of the contents config + [page.toc] + # whether to enable the table of the contents + enable = true + # FixIt 0.2.9 | NEW whether to keep the static table of the contents in front of the post + keepStatic = false + # whether to make the table of the contents in the sidebar automatically collapsed + auto = true + # FixIt 0.2.13 | NEW position of TOC ["left", "right"] + position = "right" + # FixIt 0.2.13 | NEW Display a message at the beginning of an article to warn the reader that its content might be expired + [page.expirationReminder] + enable = false + # Display the reminder if the last modified time is more than 90 days ago + reminder = 90 + # Display warning if the last modified time is more than 180 days ago + warning = 180 + # If the article expires, close the comment or not + closeComment = false + # FixIt 0.2.16 | CHANGED KaTeX mathematical formulas (https://katex.org) + [page.math] + enable = true + # default inline delimiter is $ ... $ and \( ... \) + inlineLeftDelimiter = "" + inlineRightDelimiter = "" + # default block delimiter is $$ ... $$, \[ ... \], \begin{equation} ... \end{equation} and some other functions + blockLeftDelimiter = "" + blockRightDelimiter = "" + # KaTeX extension copy_tex + copyTex = true + # KaTeX extension mhchem + mhchem = true + # FixIt 0.2.0 | NEW Code config + [page.code] + # whether to show the copy button of the code block + copy = true + # FixIt 0.2.13 | NEW whether to show the edit button of the code block + edit = true + # the maximum number of lines of displayed code by default + maxShownLines = 10 + # FixIt 0.2.14 | NEW Post edit + [page.edit] + enable = false + # FixIt 0.2.15 | CHANGED Link for fork & edit + # url = "/edit/branch-name/subdirectory-name" # base on `params.gitRepo` + # url = "https://github.com/user-name/repo-name/edit/branch-name/subdirectory-name" # full url + url = "" + # FixIt 0.2.0 | NEW Mapbox GL JS config (https://docs.mapbox.com/mapbox-gl-js) + [page.mapbox] + # access token of Mapbox GL JS + accessToken = "" + # style for the light theme + lightStyle = "mapbox://styles/mapbox/light-v9" + # style for the dark theme + darkStyle = "mapbox://styles/mapbox/dark-v9" + # whether to add NavigationControl + navigation = true + # whether to add GeolocateControl + geolocate = true + # whether to add ScaleControl + scale = true + # whether to add FullscreenControl + fullscreen = true + # FixIt 0.2.17 | NEW Donate (Sponsor) settings + [page.reward] + enable = false + animation = false + # position relative to post footer, optional values: ["before", "after"] + position = "after" + # comment = "Buy me a coffee" + # FixIt 0.2.18 | NEW display mode of QR code images, optional values: ["static", "fixed"], default: `static` + mode = "static" + [page.reward.ways] + # wechatpay = "/images/wechatpay.png" + # alipay = "/images/alipay.png" + # paypal = "/images/paypal.png" + # bitcoin = "/images/bitcoin.png" + # FixIt 0.2.0 | CHANGED social share links in post page + [page.share] + enable = true + Twitter = true + Facebook = true + Linkedin = false + Whatsapp = false + Pinterest = false + Tumblr = false + HackerNews = false + Reddit = false + VK = false + Buffer = false + Xing = false + Line = false + Instapaper = false + Pocket = false + Digg = false + Stumbleupon = false + Flipboard = false + Weibo = true + Renren = false + Myspace = false + Blogger = false + Baidu = false + Odnoklassniki = false + Evernote = false + Skype = false + Trello = false + Mix = false + # FixIt 0.2.15 | CHANGED Comment config + [page.comment] + enable = false + # FixIt 0.2.13 | NEW Artalk comment config (https://artalk.js.org/) + [page.comment.artalk] + enable = false + server = "https://yourdomain/api/" + site = "默认站点" + placeholder = "" + noComment = "" + sendBtn = "" + editorTravel = true + flatMode = "auto" + # FixIt 0.2.17 | CHANGED enable lightgallery support + lightgallery = false + locale = "" # FixIt 0.2.15 | NEW + # FixIt 0.2.18 | NEW + emoticons = "" + nestMax = 2 + nestSort = "DATE_ASC" # ["DATE_ASC", "DATE_DESC", "VOTE_UP_DESC"] + vote = true + voteDown = false + uaBadge = true + listSort = true + imgUpload = true + preview = true + versionCheck = true + # FixIt 0.1.1 | NEW Disqus comment config (https://disqus.com) + [page.comment.disqus] + enable = false + # Disqus shortname to use Disqus in posts + shortname = "" + # FixIt 0.1.1 | NEW Gitalk comment config (https://github.com/gitalk/gitalk) + [page.comment.gitalk] + enable = false + owner = "" + repo = "" + clientId = "" + clientSecret = "" + # Valine comment config (https://github.com/xCss/Valine) + [page.comment.valine] + enable = false + appId = "" + appKey = "" + placeholder = "" + avatar = "mp" + meta = "" + requiredFields = "" + pageSize = 10 + lang = "" + visitor = true + recordIP = true + highlight = true + enableQQ = false + serverURLs = "" + # FixIt 0.2.6 | NEW emoji data file name, default is "google.yml" + # ["apple.yml", "google.yml", "facebook.yml", "twitter.yml"] + # located in "themes/FixIt/assets/lib/valine/emoji/" directory + # you can store your own data files in the same path under your project: + # "assets/lib/valine/emoji/" + emoji = "" + commentCount = true # FixIt 0.2.13 | NEW + # FixIt 0.2.16 | CHANGED Waline comment config (https://waline.js.org) + [page.comment.waline] + enable = false + serverURL = "" + pageview = false # FixIt 0.2.15 | NEW + emoji = ["//unpkg.com/@waline/emojis@1.1.0/weibo"] + meta = ["nick", "mail", "link"] + requiredMeta = [] + login = "enable" + wordLimit = 0 + pageSize = 10 + imageUploader = false # FixIt 0.2.15 | NEW + highlighter = false # FixIt 0.2.15 | NEW + comment = false # FixIt 0.2.15 | NEW + texRenderer = false # FixIt 0.2.16 | NEW + search = false # FixIt 0.2.16 | NEW + recaptchaV3Key = "" # FixIt 0.2.16 | NEW + reaction = false # FixIt 0.2.18 | NEW + # Facebook comment config (https://developers.facebook.com/docs/plugins/comments) + [page.comment.facebook] + enable = false + width = "100%" + numPosts = 10 + appId = "" + languageCode = "" + # FixIt 0.2.0 | NEW Telegram comments config (https://comments.app) + [page.comment.telegram] + enable = false + siteID = "" + limit = 5 + height = "" + color = "" + colorful = true + dislikes = false + outlined = false + # FixIt 0.2.0 | NEW Commento comment config (https://commento.io) + [page.comment.commento] + enable = false + # FixIt 0.2.5 | NEW Utterances comment config (https://utteranc.es) + [page.comment.utterances] + enable = false + # owner/repo + repo = "" + issueTerm = "pathname" + label = "" + lightTheme = "github-light" + darkTheme = "github-dark" + # FixIt 0.2.13 | NEW Twikoo comment config (https://twikoo.js.org/) + [page.comment.twikoo] + enable = false + envId = "" + region = "" + path = "" + visitor = true + commentCount = true + # FixIt 0.2.17 | CHANGED enable lightgallery support + lightgallery = false + # FixIt 0.2.17 | NEW enable Katex support + katex = false + # FixIt 0.2.14 | NEW Giscus comments config + [page.comment.giscus] + enable = false + repo = "" + repoId = "" + category = "" + categoryId = "" + mapping = "" + strict = "0" # FixIt NEW | 0.2.18 + term = "" + reactionsEnabled = "1" + emitMetadata = "0" + inputPosition = "bottom" # ["top", "bottom"] + lightTheme = "light" + darkTheme = "dark" + lazyLoad = true + # FixIt 0.2.7 | NEW Third-party library config + [page.library] + [page.library.css] + # someCSS = "some.css" + # located in "assets/" + # Or + # someCSS = "https://cdn.example.com/some.css" + [page.library.js] + # someJavascript = "some.js" + # located in "assets/" + # Or + # someJavascript = "https://cdn.example.com/some.js" + # FixIt 0.2.10 | CHANGED Page SEO config + [page.seo] + # image URL + images = [] + # Publisher info + [page.seo.publisher] + name = "" + logoUrl = "" + +# FixIt 0.2.5 | NEW TypeIt config +[typeit] + # typing speed between each step (measured in milliseconds) + speed = 100 + # blinking speed of the cursor (measured in milliseconds) + cursorSpeed = 1000 + # character used for the cursor (HTML format is supported) + cursorChar = "|" + # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited) + duration = -1 + # FixIt 0.2.18 | NEW whether your strings will continuously loop after completing + loop = false + +# FixIt 0.2.15 | NEW Mermaid config +[mermaid] + # For values, see https://mermaid.js.org/config/theming.html#available-themes + themes = ["default", "dark"] + +# FixIt 0.2.12 | NEW PanguJS config +[pangu] + # For Chinese writing + enable = false + selector = "article" # FixIt 0.2.17 | NEW + +# FixIt 0.2.12 | NEW Watermark config +# Detail config see https://github.com/Lruihao/watermark#readme +[watermark] + enable = false + # watermark's text (HTML format is supported) + content = "" + # watermark's transparency + opacity = 0.1 + # parent of watermark's container + appendTo = ".wrapper>main" + # watermark's width. unit: px + width = 150 + # watermark's height. unit: px + height = 20 + # row spacing of watermarks. unit: px + rowSpacing = 60 + # col spacing of watermarks. unit: px + colSpacing = 30 + # watermark's tangent angle. unit: deg + rotate = 15 + # watermark's fontSize. unit: rem + fontSize = 0.85 + # FixIt 0.2.13 | NEW watermark's fontFamily + fontFamily = "inherit" + +# FixIt 0.2.12 | NEW Busuanzi count +[ibruce] + enable = false + # Enable in post meta + enablePost = false + +# Site verification code config for Google/Bing/Yandex/Pinterest/Baidu/360/Sogou +[verification] + google = "" + bing = "" + yandex = "" + pinterest = "" + baidu = "" + so = "" + sogou = "" + +# FixIt 0.2.10 | NEW Site SEO config +[seo] + # image URL + image = "" + # thumbnail URL + thumbnailUrl = "" + +# FixIt 0.2.0 | NEW Analytics config +[analytics] + enable = false + # Google Analytics + [analytics.google] + id = "" + # whether to anonymize IP + anonymizeIP = true + # Fathom Analytics + [analytics.fathom] + id = "" + # server url for your tracker if you're self hosting + server = "" + +# FixIt 0.2.7 | NEW Cookie consent config +[cookieconsent] + enable = true + # text strings used for Cookie consent banner + [cookieconsent.content] + message = "" + dismiss = "" + link = "" + +# FixIt 0.2.7 | CHANGED CDN config for third-party library files +[cdn] + # CDN data file name, disabled by default ["jsdelivr.yml", "unpkg.yml", ...] + # located in "themes/FixIt/assets/data/cdn/" directory + # you can store your own data files in the same path under your project: "assets/data/cdn/" + data = "" + +# FixIt 0.2.8 | NEW Compatibility config +[compatibility] + # whether to use Polyfill.io to be compatible with older browsers + polyfill = false + # whether to use object-fit-images to be compatible with older browsers + objectFit = false + +# FixIt 0.2.14 | NEW GitHub banner in the top-right or top-left corner +[githubCorner] + enable = false + permalink = "https://github.com/hugo-fixit/FixIt" + title = "View source on GitHub" + position = "right" # ["left", "right"] + +# FixIt 0.2.14 | NEW Gravatar config +[gravatar] + # FixIt 0.2.18 | NEW Depends on the author's email, if the author's email is not set, the local avatar will be used + enable = true + # Gravatar host, default: "www.gravatar.com" + host = "gravatar.loli.net" # ["cn.gravatar.com", "gravatar.loli.net", ...] + style = "" # ["", "mp", "identicon", "monsterid", "wavatar", "retro", "blank", "robohash"] + +# FixIt 0.2.16 | NEW Back to top +[backToTop] + enable = true + # Scroll percent label in b2t button + scrollpercent = false + +# FixIt 0.2.16 | NEW Reading progress bar +[readingProgress] + enable = false + # Available values: ["left", "right"] + start = "left" + # Available values: ["top", "bottom"] + position = "top" + reversed = false + light = "" + dark = "" + height = "2px" + +# FixIt 0.2.17 | NEW Progress bar in the top during page loading. +# For more information: https://github.com/CodeByZach/pace +[pace] + enable = false + # All available colors: + # ["black", "blue", "green", "orange", "pink", "purple", "red", "silver", "white", "yellow"] + color = "blue" + # All available themes: + # ["barber-shop", "big-counter", "bounce", "center-atom", "center-circle", "center-radar", "center-simple", + # "corner-indicator", "fill-left", "flash", "flat-top", "loading-bar", "mac-osx", "material", "minimal"] + theme = "minimal" + +# FixIt 0.2.18-lts.3 | NEW [Experimental] cache remote images locally, see: https://github.com/hugo-fixit/FixIt/pull/362 +[cacheRemoteImages] + enable = false + # replace remote image url with local image url + replace = false + +# FixIt 0.2.17 | NEW Define custom file paths +# Create your custom files in site directory `layouts/partials/custom` and uncomment needed files below +[customFilePath] + # aside = "custom/aside.html" + # profile = "custom/profile.html" + # footer = "custom/footer.html" + +# FixIt 0.2.15 | NEW Developer options +[dev] + enable = false + # Check for updates + c4u = false + # Please do not expose to public! + githubToken = "" + # Mobile Devtools config + [dev.mDevtools] + enable = false + # "vConsole", "eruda" supported + type = "vConsole" diff --git a/config/_default/permalinks.toml b/config/_default/permalinks.toml new file mode 100644 index 0000000..17b11a4 --- /dev/null +++ b/config/_default/permalinks.toml @@ -0,0 +1,8 @@ +# ------------------------------------------------------------------------------------- +# Permalinks Configuration +# See: https://gohugo.io/content-management/urls/#permalinks +# ------------------------------------------------------------------------------------- + +# posts = ":year/:month/:filename" +posts = "posts/:filename" +private = ":sections[1:]/:filename" diff --git a/config/_default/privacy.toml b/config/_default/privacy.toml new file mode 100644 index 0000000..e250dad --- /dev/null +++ b/config/_default/privacy.toml @@ -0,0 +1,9 @@ +# ------------------------------------------------------------------------------------- +# Privacy Configuration +# See: https://gohugo.io/about/hugo-and-gdpr/ +# ------------------------------------------------------------------------------------- + +[twitter] + enableDNT = true +[youtube] + privacyEnhanced = true diff --git a/config/_default/sitemap.toml b/config/_default/sitemap.toml new file mode 100644 index 0000000..d83eff5 --- /dev/null +++ b/config/_default/sitemap.toml @@ -0,0 +1,8 @@ +# ------------------------------------------------------------------------------------- +# Sitemap Configuration +# See: https://gohugo.io/templates/sitemap-template/#configuration +# ------------------------------------------------------------------------------------- + +changefreq = "weekly" +filename = "sitemap.xml" +priority = 0.5 \ No newline at end of file diff --git a/content/posts/hello-world.md b/content/posts/hello-world.md new file mode 100644 index 0000000..a626567 --- /dev/null +++ b/content/posts/hello-world.md @@ -0,0 +1,89 @@ +--- +title: Hello World +date: 2022-09-29T17:06:11+08:00 +tags: +- hello +- FixIt +categories: +- hello +code: + maxShownLines: 11 +# See details front matter: https://fixit.lruihao.cn/documentation/content-management/introduction/#front-matter +--- + +Welcome to Hugo FixIt! This is your very first post. + + + +Head to the documentation page linked below for a complete guidence to get started with the [FixIt](https://github.com/hugo-fixit/FixIt) theme. + +{{< link href="https://fixit.lruihao.cn/documentation/" content="All Documentation - FixIt" title="documentation of FixIt Theme" card=true >}} + +## Quick Start + +For a complete quick start, see this [page](https://fixit.lruihao.cn/documentation/getting-started/). + +### Prerequisites + +[Hugo](https://gohugo.io/installation/): >= 0.109.0 (extended version) + +### Use this Template + +1. Click **Use this template**, and create your repository on GitHub. + + image + +2. Once the repository is created, just clone and enjoy it! + + ```bash + # Clone with your own repository url + git clone --recursive https://github.com//.git + ``` + +### Launching the Site + +```bash +# Development environment +hugo server +# Production environment +hugo server -e production +``` + +### Build the Site + +When your site is ready to deploy, run the following command: + +```bash +hugo +``` + +### Update theme + +Afterwards you can upgrade the theme with the following command: + +```bash +# Update theme manually +git submodule update --remote --merge themes/FixIt +``` + +
+ Start via NPM script + + ```bash + # build the blog + npm run build + # run a local debugging server with watch + npm run server + # run a local debugging server in production environment + npm run server:production + # update theme submodules + npm run update:theme + ``` + +
+ +## Feedback + +Whether it's questions, ideas, bugs or pull requests, all feedback is welcome! + +Head over to the [issues](https://github.com/hugo-fixit/FixIt/issues) or [discussions](https://github.com/hugo-fixit/FixIt/discussions) tracker. diff --git a/package.json b/package.json new file mode 100644 index 0000000..f535911 --- /dev/null +++ b/package.json @@ -0,0 +1,22 @@ +{ + "name": "hugo-fixit-blog", + "version": "1.0.0", + "description": "This is a quick start template for Hugo theme [FixIt](https://github.com/hugo-fixit/FixIt). It uses Git submodule feature to load the theme.", + "main": "index.js", + "scripts": { + "build": "hugo -v --gc --minify", + "server": "hugo server -D --disableFastRender --navigateToChanged --bind 0.0.0.0", + "server:production": "npm run server -- --environment production", + "update:theme": "git submodule update --remote --merge themes/FixIt && git add . && git commit -m ':arrow_up: Chore(theme): update FixIt version'" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/hugo-fixit/hugo-fixit-blog.git" + }, + "author": "Lruihao (https://github.com/Lruihao)", + "license": "MIT", + "bugs": { + "url": "https://github.com/hugo-fixit/hugo-fixit-blog/issues" + }, + "homepage": "https://github.com/hugo-fixit/hugo-fixit-blog#readme" +} diff --git a/static/CNAME b/static/CNAME new file mode 100644 index 0000000..5dd5430 --- /dev/null +++ b/static/CNAME @@ -0,0 +1 @@ +demo.fixit.lruihao.cn \ No newline at end of file diff --git a/themes/FixIt b/themes/FixIt new file mode 160000 index 0000000..95c8113 --- /dev/null +++ b/themes/FixIt @@ -0,0 +1 @@ +Subproject commit 95c8113d626eeaa463ebda26ac326125ef3516dd