{"id":14981456,"url":"https://github.com/manid2/hugo-xterm","last_synced_at":"2025-08-20T20:32:00.444Z","repository":{"id":181032742,"uuid":"666105876","full_name":"manid2/hugo-xterm","owner":"manid2","description":"Hugo theme designed for reading and printing text with dark and light modes.","archived":false,"fork":false,"pushed_at":"2025-03-22T09:57:00.000Z","size":1722,"stargazers_count":46,"open_issues_count":1,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T20:48:54.687Z","etag":null,"topics":["blog","dark-theme","hugo","hugo-theme","light-theme","minimal","personal-website","portfolio-website","print-friendly","reveal-js"],"latest_commit_sha":null,"homepage":"https://manid2.github.io/hugo-xterm/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manid2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://buymeacoffee.com/manid2"}},"created_at":"2023-07-13T18:15:30.000Z","updated_at":"2025-03-22T09:27:19.000Z","dependencies_parsed_at":"2024-04-13T21:21:14.249Z","dependency_job_id":"1593ca01-ffd4-4ba1-8a7d-baec3a7740db","html_url":"https://github.com/manid2/hugo-xterm","commit_stats":{"total_commits":152,"total_committers":2,"mean_commits":76.0,"dds":0.006578947368421018,"last_synced_commit":"fd1e871462e27969e1fc6bc5851033988c89c1b5"},"previous_names":["manid2/hugo-xterm"],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/manid2/hugo-xterm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manid2%2Fhugo-xterm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manid2%2Fhugo-xterm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manid2%2Fhugo-xterm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manid2%2Fhugo-xterm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manid2","download_url":"https://codeload.github.com/manid2/hugo-xterm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manid2%2Fhugo-xterm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271378680,"owners_count":24749192,"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","status":"online","status_checked_at":"2025-08-20T02:00:09.606Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","dark-theme","hugo","hugo-theme","light-theme","minimal","personal-website","portfolio-website","print-friendly","reveal-js"],"created_at":"2024-09-24T14:03:36.134Z","updated_at":"2025-08-20T20:32:00.430Z","avatar_url":"https://github.com/manid2.png","language":"HTML","funding_links":["https://buymeacoffee.com/manid2","https://www.buymeacoffee.com/manid2"],"categories":[],"sub_categories":[],"readme":"hugo-xterm\n==========\n\nHugo theme designed for reading and printing text with dark and light modes.\n\nIt uses Hugo extended version with __\u003e= 0.110__ to build the theme to take\nadvantage of builtin SCSS compiler and reduce dependency on external\nlibraries.\n\nThis theme is fully free and open source so it can be used and modified as you\nlike but redistributing requires attribution to [license][hx_lic_link] and\ncredits to author [Mani Kumar][md2_gh_link] with link to this repository\n[hugo-xterm][hx_gh_link].\n\n[![Hugo][hugo_ver_img]][hugo_v0110]\n[![LICENSE][hx_lic_img]][hx_lic_link]\n[![Build][hx_ci_build_img]][hx_ci_build_link]\n\nDemo\n----\n\nDemo example site [manid2.github.io/hugo-xterm][7].\n\n[![Hugo Xterm demo site QR code][hx_demo_qr_img]][7]\n\nScreenshots\n-----------\n\n### Dark mode\n\n![Hugo Xterm Dark][hx_ss_dark]\n\n### Light mode\n\n![Hugo Xterm Light][hx_ss_light]\n\nFeatures\n--------\n\n### Unique features\n\n* Designed for __reading__ and __printing__ text.\n* __Print:__ any page in light theme mode for readability.\n* __Lists__: separate view and pagination for simple list items and post\n  entries.\n* __GitInfo:__ show the latest git commit short hash and subject message for\n  each page (requires Hugo GitInfo config enabled).\n* __Fonts:__\n  - __\"Roboto Slab (serif)\"__ for title (heading) text.\n  - __\"Fira Sans (sans-serif)\"__ for normal text.\n  - __\"Ubuntu Mono (monospace)\"__ for code.\n* __Colors:__ in the theme are derived using a single primary color (blue)\n  from the [HSL colors][8].\n* Website banner is supported.\n\n### Adopted features\n\n* Minimal configuration.\n* Switchable dark and light themes with automatic selection based on system\n  theme.\n* SEO friendly OpenGraph and twitter cards support\n* Customizable using configurations for: \"full width\", \"centered\".\n* Taxonomies and posts RSS.\n* Responsive tested on desktop and on smart phones.\n* Responsive menus for desktop and mobile screens.\n* Accessibility tested using [WAVE Web Accessibility Evaluation Tool][5].\n* Code blocks are highlighted using Hugo built-in blazing fast [Chroma][9].\n* Copy code, see code language and file name (optional).\n* Tightly coupled with Hugo extended latest version (v1.110.0) to compile and\n  generate asset bundles with pipelines, fingerprinting and minification.\n* Support for favicon which is displayed in browser tabs and bookmarks bar.\n\n#### How to add favicon in Hugo-xterm\n\n* Add your favicon images to `static` directory.\n  Example: `static/images/xterm.png`.\n* Add the favicon image path to `config.toml`.\n\n  ```toml\n  [params]\n    favicon=\"/images/xterm.png\"\n  ```\n\nFor working example check `exampleSite` directory to know how favicon is\nadded.\n\n### Other features\n\nThese are supported due to [panr/terminal][1] theme base code but not\ntested as I don't use them myself:\n\n* Post cover image.\n* Images in post with caption.\n* Comments.\n\nInstallation\n------------\n\nFollow the steps in any one of these methods to install or update a Hugo\ntheme.\n\n### Method - Using hugo mod\n\nAdd hugo-xterm theme as Hugo module to hide the theme content and let you\nfocus only on your site content. Let Hugo handle the theme updates\nautomatically and control the theme as a Hugo module instead of git.\n\n```bash\ncd \u003cyour-site-directory\u003e\n\n# initialize your site as a hugo module.\nhugo mod init \u003cyour-repo-host/your-username/your-site-repo\u003e\n\n# import hugo-xterm theme as hugo module in configuration\n$ cat config/_default/config.toml\n[module]\n  [[module.imports]]\n    path = \"github.com/manid2/hugo-xterm\"\n\n# update theme\nhugo mod get -u\n```\n\nFor all below methods your site needs to point to hugo-xterm theme\nsubdirectory in configuration as below:\n\n```bash\n$ cat config/_default/config.toml\ntheme = \"hugo-xterm\"\n```\n\n### Method - Download and copy theme\n\nDownload the archived (i.e. .zip or tar.gz) theme from github repository\nreleases page. Extract and copy the contents into `themes/hugo-xterm`\nsubdirectory in your site directory.\n\nTo update the theme just download a new release and overwrite the same\nsubdirectory.\n\nThis method is simple, can be automated with script and saves space on disk by\nomitting the theme repository history.\n\n### Method - Using git clone\n\nThis method clones the theme repository with history into your site's themes\nsubdirectory which is useful if you want to control the history or make your\nown private modifications to the theme.\n\n```bash\ncd \u003cyour-site-directory\u003e\ngit clone https://github.com/manid2/hugo-xterm themes/hugo-xterm --depth=1\n\n# update theme\ncd themes/hugo-xterm\ngit pull\n```\n\n### Method - Using git submodule\n\nThis is similar to cloning the theme into subdirectory except using git\nsubmodule which makes the theme acts a dependency of your site repository. It\nlets git to control your site and its dependency this theme.\n\n```bash\ngit submodule add --depth=1 https://github.com/manid2/hugo-xterm \\\nthemes/hugo-xterm\n\n# update theme\ngit submodule update --remote --merge\n```\n\nLocal development\n-----------------\n\n```bash\n# add to go.mod for local development\n# replace github.com/manid2/hugo-xterm =\u003e ../hugo-xterm\nhugo server --source exampleSite\n\n# generate tags\nctags -R assets/ layouts/ config.toml theme.toml\n\n# generate tags for exampleSite\nctags -R exampleSite/layouts/ exampleSite/scripts/ exampleSite/config\n```\n\nRequest feature \u0026 report bugs\n-----------------------------\n\nIf you find any bugs or need any features then please raise an\n[issue][hx_gh_issues_link] so that it can tracked and avoid same requests from\nother users.\n\nYou can also fix the bug or implement the feature yourself and raise a [pull\nrequest][hx_gh_pr_link] so I can review and integrate it into this theme with\ncredits to you as a contributor.\n\nUse the theme \u0026 want to show your site?\n---------------------------------------\n\nI would be happy to know that you use this theme and want to show your site.\nFor this please raise a pull request with link to your site, your\nname/username, profession/study mentioned in this list [hugo-xterm\nusers][hx_users_link].\n\nSupport\n-------\n\nKindly support this theme development by donating at [Buy me a\ncoffee][md2_bmc_link].\n\nTODO Add current supporters.\n\n[![Mani Kumar Buy Me a Coffee QR code][md2_bmc_qr_img]][md2_bmc_link]\n\nCredits\n-------\n\nThis theme was initially based on [panr/terminal][1] theme but is re-written\nfrom scratch to optimize for reading and print text heavy web pages.\n\nParts of the features in this theme are either taken directly or based on the\nfeatures from popular themes and websites as listed below:\n\n* [panr/terminal][1]: most styles, menus and starter code.\n* [adityatelange/hugo-PaperMod][2] features: breadcrumbs and copy code.\n* [kaitlinmctigue/kaitlinmctigue.github.io][3]: dark and light theme modes.\n\nLicense\n-------\n\n[GNU General Public License v3.0][hx_lic_link]\n\n[1]: https://github.com/panr/hugo-theme-terminal\n[2]: https://github.com/adityatelange/hugo-PaperMod\n[3]: https://github.com/kaitlinmctigue/kaitlinmctigue.github.io\n[5]: https://wave.webaim.org/\n[7]: https://manid2.github.io/hugo-xterm/\n[8]: https://en.wikipedia.org/wiki/HSL_and_HSV\n[9]: https://github.com/alecthomas/chroma/\n\n[hx_ci_build_img]: https://img.shields.io/github/actions/workflow/status/manid2/hugo-xterm/hugo.yaml?logo=github \"Hugo Xterm build status badge\"\n[hx_ci_build_link]: https://github.com/manid2/hugo-xterm/actions\n\n[hx_lic_img]: https://img.shields.io/github/license/manid2/hugo-xterm?logo=gnu\u0026logoColor=black\u0026label=License\u0026labelColor=lightcyan \"Hugo Xterm license badge\"\n[hx_lic_link]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE\n\n[hugo_ver_img]: https://img.shields.io/badge/Hugo%20Extended-%3E%3D%20v0.110.0-blue.svg?style=flat\u0026logo=hugo\u0026logoColor=white\u0026label=Hugo%20Extended\u0026labelColor=grey \"Hugo Extended \u003e= v0.110.0\"\n[hugo_v0110]: https://github.com/gohugoio/hugo/releases/tag/v0.110.0\n\n[hx_ss_dark]: https://manid2.github.io/hugo-xterm/screenshots/hugo-xterm-ss-01-dark.png \"Hugo Xterm dark mode screenshot\"\n[hx_ss_light]: https://manid2.github.io/hugo-xterm/screenshots/hugo-xterm-ss-02-light.png \"Hugo Xterm light mode screenshot\"\n\n[hx_demo_qr_img]: https://quickchart.io/qr?text=https%3A%2F%2Fmanid2.github.io%2Fhugo-xterm%2F\u0026dark=1a5fb4\u0026size=200\n[hx_gh_link]: https://github.com/manid2/hugo-xterm\n[hx_gh_issues_link]: https://github.com/manid2/hugo-xterm/issues\n[hx_gh_pr_link]: https://github.com/manid2/hugo-xterm/pulls\n[hx_users_link]: https://github.com/manid2/hugo-xterm/blob/main/USERS.md\n\n[md2_bmc_link]: https://www.buymeacoffee.com/manid2\n[md2_bmc_qr_img]: https://manid2.github.io/images/md2_bmc_qr.png\n[md2_gh_link]: https://github.com/manid2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanid2%2Fhugo-xterm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanid2%2Fhugo-xterm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanid2%2Fhugo-xterm/lists"}