{"id":15147167,"url":"https://github.com/qdzhang/hugo-notepadium-mod","last_synced_at":"2025-10-24T03:30:22.210Z","repository":{"id":39641107,"uuid":"344761802","full_name":"qdzhang/hugo-notepadium-mod","owner":"qdzhang","description":"Hugo notepadium theme modify \u0026 module","archived":false,"fork":false,"pushed_at":"2022-05-30T02:31:36.000Z","size":1541,"stargazers_count":22,"open_issues_count":0,"forks_count":11,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T22:35:53.129Z","etag":null,"topics":["blog","blog-theme","giscus","hugo","hugo-blog-theme","hugo-module","hugo-site","hugo-theme","static-site","theme"],"latest_commit_sha":null,"homepage":"https://theme-notemod.littlezhang.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qdzhang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-05T09:36:50.000Z","updated_at":"2024-04-14T04:38:40.000Z","dependencies_parsed_at":"2022-08-28T10:01:18.536Z","dependency_job_id":null,"html_url":"https://github.com/qdzhang/hugo-notepadium-mod","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdzhang%2Fhugo-notepadium-mod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdzhang%2Fhugo-notepadium-mod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdzhang%2Fhugo-notepadium-mod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdzhang%2Fhugo-notepadium-mod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qdzhang","download_url":"https://codeload.github.com/qdzhang/hugo-notepadium-mod/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237905572,"owners_count":19385037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","blog-theme","giscus","hugo","hugo-blog-theme","hugo-module","hugo-site","hugo-theme","static-site","theme"],"created_at":"2024-09-26T12:23:05.810Z","updated_at":"2025-10-24T03:30:21.665Z","avatar_url":"https://github.com/qdzhang.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hugo-notepadium-mod \n\n![](https://img.shields.io/badge/license-MIT-blue.svg) [![Netlify Status](https://api.netlify.com/api/v1/badges/b0669122-2fec-4094-b3ce-f5717ba90517/deploy-status)](https://app.netlify.com/sites/distracted-mirzakhani-1980a4/deploys)\n\n[English](./README.md) | [中文](./README.zh-CN.md) | [✨**Live demo**](https://theme-notemod.littlezhang.com/) | [✨littlezhang's blog](https://www.littlezhang.com)\n\nA fast and simple [Hugo](https://gohugo.io) theme, **100% JavaScript-free**.\n\n![notepadium-mod](./images/Notepadium-mod.png)\n\n\u003c!-- vim-markdown-toc GFM --\u003e\n\n* [Introduce](#introduce)\n* [Features](#features)\n  * [Different from original notepadium theme:](#different-from-original-notepadium-theme)\n  * [Other features](#other-features)\n* [Get start](#get-start)\n  * [Option 1](#option-1)\n  * [Option 2](#option-2)\n* [Configure theme](#configure-theme)\n* [Update theme](#update-theme)\n* [Customize theme](#customize-theme)\n* [Thanks](#thanks)\n* [License](#license)\n\n\u003c!-- vim-markdown-toc --\u003e\n\n## Introduce\n\nA Hugo theme forked from [early version](https://github.com/cntrump/hugo-notepadium/releases/tag/v2.1.0) of [hugo-notepadium](https://github.com/cntrump/hugo-notepadium).\n\n**[WIP] The project and readme is still working in progress! You can contact me if you have any question.**\n\nRequest Hugo Version: [0.68.0+](https://github.com/gohugoio/hugo/releases/)\n\n## Features \n\n### Different from original notepadium theme:\n- grid layout ([Can I use grid?](https://caniuse.com/?search=grid))\n- tags cloud\n- toc\n- preconnect and prefetch for resourses\n- inline critical css\n- [hugo modules](https://gohugo.io/categories/hugo-modules)\n- archive page\n- light \u0026 dark theme toggle button\n- search in site (powered by [stork](https://github.com/jameslittle230/stork)) [How to use it?]()\n- more useful Hugo shortcodes\n  - tips blocks(alert messages)\n  - plist for simple table in markdown\n\n### Other features\n\n- Logo\n- Navigation items\n- Syntax highlighting\n- Math supporting\n- Pagination with large number of pages supporting\n- Light \u0026 Dark\n- Custom CSS supporting\n- Custom JS supporting\n- Custom header right items supporting\n\n## Get start\n\nThere are two ways to use this theme for Hugo site.\n\n### Option 1\n\nUse Hugo modules. Hugo Modules is powered by Go Modules. If you have installed [Go](https://golang.org/), this option is **recommended**. More details can be found in [Hugo Docs](https://gohugo.io/hugo-modules/use-modules/)\n\n1. Initialize the hugo module system in your site root: \n\n```bash\nhugo mod init github.com/\u003cyour_user\u003e/\u003cyour_project\u003e\n```\n\n2. Import the theme in your config.toml:\n\n```toml\n[module]\n  [[module.imports]]\n    path = \"github.com/qdzhang/hugo-notepadium-mod\"\n```\n\n### Option 2\n\nUse git submodule.\n\n1. Add theme repository as git submodule\n\n```bash\ngit submodule add https://github.com/qdzhang/hugo-notepadium-mod.git themes/hugo-notepadium-mod\n```\n\n2. Set theme in your config.toml\n\n```toml\ntheme = \"hugo-notepadium-mod\"\n```\n\n## Configure theme\n\nAlmost everything can be configured in the `config.toml` file of your site. If you want to modify the theme, you could go to [Customize theme](#customize-theme)\n\nThere is an example `config.toml`:\n\n```toml\n\nbaseURL = \"https://www.example.com/\"\ntitle = \"Hugo-notepadium-mod\"\ncopyright = \"©2021 hugo-notepadium-mod\"\n\nlanguageCode = \"zh-cn\"\nhasCJKLanguage = true\ndefaultContentLanguage = \"zh-cn\"\n\nenableRobotsTXT = true\npaginate = 7  # The number of articles in per page\nenableEmoji = true\n\n# Enable Disqus\n#disqusShortname = \"XXX\"\n\n# Google Analytics\n#googleAnalytics = \"UA-123-45\"\n\n\n[module]\n  [[module.imports]]\n    path = \"github.com/qdzhang/hugo-notepadium-mod\"  # Use module to use this theme\n\n[minify]\n# Deploy with --minify command to minify assets\n# Need Hugo version v0.68.0+\n  disableCSS = false\n  disableHTML = false\n  disableJS = false\n  disableJSON = false\n  disableSVG = false\n  disableXML = false\n  minifyOutput = true\n  [minify.tdewolff]\n    [minify.tdewolff.css]\n      keepCSS2 = true\n      precision = 1\n    [minify.tdewolff.html]\n      keepComments = false\n      keepConditionalComments = true\n      keepDefaultAttrVals = true\n      keepDocumentTags = true\n      keepEndTags = true\n      keepQuotes = false\n      keepWhitespace = false\n    [minify.tdewolff.js]\n      keepVarNames = false\n      precision = 1\n    [minify.tdewolff.json]\n      precision = 0\n    [minify.tdewolff.svg]\n      precision = 1\n    [minify.tdewolff.xml]\n      keepWhitespace = false\n\n# Configure chroma highlight\n# Reference https://gohugo.io/content-management/syntax-highlighting/\n# https://gohugo.io/getting-started/configuration-markup#highlight\n[markup.highlight]\ncodeFences = true\nguessSyntax = true\nnoClasses = true\nstyle = \"dracula\"\n\n[markup.goldmark.renderer]\nunsafe = true  # enable raw HTML in Markdown\n\n[markup.tableOfContents]\n    endLevel = 3\n    ordered = false\n    startLevel = 2\n\n[permalinks]\n  post = \"/:year/:month/:title/\"\n\n[author]\n    name = \"理头张\"  # Change to your name\n\n\n[params]\nauthor = \"理头张\"\ndescription = \"littlezhang's blog\"\nstyle = \"auto\"  # default: auto. light: light theme, dark: dark theme, auto: based on system.\nlogo = \"https://cdn.jsdelivr.net/gh/qdzhang/littlezhang.com/static/logo.png\"\nslogan = \"\"\n#license = \"\u003ca rel=license href=http://creativecommons.org/licenses/by-nc-sa/4.0/\u003e\u003cimg alt=Creative Commons License style=border-width:0 src=https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png /\u003e\u003c/a\u003e\u003cbr /\u003eThis work is licensed under a \u003ca rel=license href=http://creativecommons.org/licenses/by-nc-sa/4.0/\u003eCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International License\u003c/a\u003e.\"\n\n# If you use custom css files, declare them here\n[params.assets]\ncss = [\"css/fonts.css\", \"css/custom.css\"]\n\n[params.comments]\nenable = false  # En/Disable comments globally, default: false. You can always enable comments on per page.\n\n[params.math]\nenable = false # load math globally, default: false. You can always enable math on per page.\nuse = \"katex\"  # builtin: \"katex\", \"mathjax\".  default: \"katex\"\n\n[params.nav]\nshowCategories = false       # /categories/\nshowTags = false             # /tags/\n\n# You can add taxonomies in there, then link new pages in [[params.nav.custom]]\n# Reference https://gohugo.io/content-management/taxonomies/\n[taxonomies]\n  category = \"categories\"\n  tag = \"tags\"\n\n[[params.nav.custom]]\ntitle = \"Index\"\nurl = \"/\"\n\n[[params.nav.custom]]\ntitle = \"Tags\"\nurl = \"/tags/\"\n\n[[params.nav.custom]]\ntitle = \"Archives\"\nurl = \"/archives/\"\n\n[[params.nav.custom]]\ntitle = \"About\"\nurl = \"/about/\"\n```\n\n## Update theme\n\nIf you installed the theme by Hugo module\n\n```bash\nhugo mod get -u  # This will update all modules\nhugo mod get -u github.com/qdzhang/hugo-notepadium-mod  # This will update current theme\n```\n\nIf you installed the theme by git submodule, first go to the theme directory, then `git pull`\n\n```bash\ncd themes/hugo-notepadium-mod \u0026\u0026 git pull\n```\n\n## Customize theme\n\n## Thanks\n\n- [**Hugo**](https://gohugo.io/)\n- [**hugo-notepadium**](https://github.com/cntrump/hugo-notepadium)\n- [**MathJax**](https://www.mathjax.org/)\n- [**Katex**](https://katex.org/)\n- [**stork**](https://github.com/jameslittle230/stork)\n- Some minimal designs inspired by [**Kev Quirk**](https://kevq.uk/) \n\n## License\n\nOpen source licensed under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqdzhang%2Fhugo-notepadium-mod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqdzhang%2Fhugo-notepadium-mod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqdzhang%2Fhugo-notepadium-mod/lists"}