{"id":13475683,"url":"https://github.com/hugo-toha/toha","last_synced_at":"2025-05-14T07:09:38.295Z","repository":{"id":37849212,"uuid":"254809249","full_name":"hugo-toha/toha","owner":"hugo-toha","description":"A Hugo theme for personal portfolio","archived":false,"fork":false,"pushed_at":"2025-04-06T13:52:40.000Z","size":41831,"stargazers_count":1107,"open_issues_count":47,"forks_count":659,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-04-11T02:51:38.588Z","etag":null,"topics":["blog","hacktoberfest","hacktoberfest-accepted","hugo","hugo-site","personal-site","personal-website","portfolio","portfolio-site","theme","toha"],"latest_commit_sha":null,"homepage":"https://hugo-toha.github.io","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/hugo-toha.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-11T06:42:21.000Z","updated_at":"2025-04-10T13:44:15.000Z","dependencies_parsed_at":"2023-09-26T21:27:47.460Z","dependency_job_id":"65a56e92-5b9a-484e-8d67-311ae5ecc8df","html_url":"https://github.com/hugo-toha/toha","commit_stats":{"total_commits":652,"total_committers":113,"mean_commits":5.769911504424779,"dds":0.7929447852760736,"last_synced_commit":"047bb517cbee2427b63e35c733becd1430d62206"},"previous_names":["hossainemruz/toha"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugo-toha%2Ftoha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugo-toha%2Ftoha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugo-toha%2Ftoha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugo-toha%2Ftoha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugo-toha","download_url":"https://codeload.github.com/hugo-toha/toha/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092787,"owners_count":22013290,"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","hacktoberfest","hacktoberfest-accepted","hugo","hugo-site","personal-site","personal-website","portfolio","portfolio-site","theme","toha"],"created_at":"2024-07-31T16:01:22.530Z","updated_at":"2025-05-14T07:09:33.280Z","avatar_url":"https://github.com/hugo-toha.png","language":"HTML","funding_links":[],"categories":["HTML","hacktoberfest"],"sub_categories":[],"readme":"\u003e [!IMPORTANT]\n\u003e If you are migrating from v3 (`git submodule` based) theme to v4 (`hugo modules` based) theme, please read this [migration guide](https://toha-guides.netlify.app/posts/update-v3-to-v4/).\n\n# Toha\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/b1b93b02-f278-440b-ae1b-304e9f4c4ab5/deploy-status)](https://app.netlify.com/sites/toha/deploys)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fhugo-toha%2Ftoha%2Fbadge%3Fref%3Dmain\u0026style=flat)](https://actions-badge.atrox.dev/hugo-toha/toha/goto?ref=main)\n![Repository Size](https://img.shields.io/github/repo-size/hugo-toha/toha)\n![Lines of Codes](https://img.shields.io/tokei/lines/github.com/hugo-toha/toha)\n![Contributor](https://img.shields.io/github/contributors/hugo-toha/toha)\n![Latest Release](https://img.shields.io/github/v/release/hugo-toha/toha?include_prereleases)\n![Last Commit](https://img.shields.io/github/last-commit/hugo-toha/toha)\n![Open Issues](https://img.shields.io/github/issues/hugo-toha/toha?color=important)\n![Open Pull Requests](https://img.shields.io/github/issues-pr/hugo-toha/toha?color=yellowgreen)\n![License](https://img.shields.io/github/license/hugo-toha/toha)\n![Security Headers](https://img.shields.io/security-headers?url=https%3A%2F%2Fhugo-toha.github.io%2F)\n[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/b7cb60ab/hugo-toha.github.io)\n\nA [Hugo](https://gohugo.io/) theme for a personal portfolio with minimalist design and responsiveness.\n\n![Thumbnail](https://raw.githubusercontent.com/hugo-toha/toha/main/images/screenshot.png)\n\n- **Example Site:** [hugo-toha.github.io](https://hugo-toha.github.io)\n- **Documentation:** [toha-guides.netlify.app](https://toha-guides.netlify.app/posts)\n\n## Features\n\n- Minimalist Design\n- Fully Responsive\n- Multiple Language Support\n- Carefully Designed Cards\n- Experience Timeline\n- Achievement Gallery\n- Sidebar to Categorize the Posts\n- Short Codes\n- Analytics Support\n  - GoatCounter\n  - counter.dev\n  - Google Analytics\n  - Matomo/Piwik\n  - [Umami](https://umami.is/)\n- Comment Support\n  - [Disqus](https://disqus.com/)\n  - [Valine](https://valine.js.org/)\n  - [Uttarances](https://utteranc.es/)\n  - [Giscus](https://giscus.app/)\n\nFor more details about the features please visit [here](https://toha-guides.netlify.app/posts/features/).\n\n## Available Translations\n\n- English\n- বাংলা\n- Français\n- Indonesian\n- Deutsch\n- Español\n- 简体中文\n- 繁體中文\n- हिन्दी\n- Italiano\n- 日本語\n- 한국어\n- русский\n- suomi\n- Tiếng Việt\n- Azerbaijan\n- Turkish\n- Arabic (العربية)\n- Português Europeu\n- Català\n- Português Brasileiro\n- Nederlands\n- Hebrew\n\nTo know more about how to translate your site, please visit [here](https://toha-guides.netlify.app/posts/translation/). Follow, the data and post format from this [example site](https://hugo-toha.github.io).\n\n## Screenshots\n\nHere are few screenshots from the [example site](https://hugo-toha.github.io).\n\n##### Home Page Sections\n\n![Home Page Sections](https://raw.githubusercontent.com/hugo-toha/toha/main/images/about.png)\n\n##### List Page\n\n![List Page](https://raw.githubusercontent.com/hugo-toha/toha/main/images/list.png)\n\n##### Reading Page\n\n![Reading Page](https://raw.githubusercontent.com/hugo-toha/toha/main/images/single.png)\n\n## Requirements\n\n- Hugo Version 0.128.0 (extended) or higher\n- Go language 1.18 or higher (require for hugo modules)\n- Node version v18.x or later and npm 8.x or later.\n\n## Usage\n\nThe easiest way to use this theme is to fork [hugo-toha.github.io](https://github.com/hugo-toha/hugo-toha.github.io) sample repo.Then change the configurations according to your need.\n\nIf you want to start from scratch, then follow these steps:\n\n##### 1. Initialize Hugo module on you repo\n\nAt first, initialize [Hugo modules](https://gohugo.io/hugo-modules/) in your repo. This will create a `go.mod` file.\n\n```bash\nhugo mod init github.com/\u003cyour username\u003e/\u003cyour repo name\u003e\n```\n\n##### 2. Add this theme as your module dependency\n\nNow, in your `hugo.yaml` file, add a `module` section.\n\n```yaml\n# Use Hugo modules to add theme\nmodule:\n  imports:\n  - path: github.com/hugo-toha/toha/v4\n```\n\nCheck this sample [hugo.yaml](https://github.com/hugo-toha/hugo-toha.github.io/blob/main/hugo.yaml) for further reference.\n\n##### 3. Update your module\n\nNow, run this command to load this theme as your module.\n\n```bash\nhugo mod tidy\n```\n\n#### Running Locally\n\nNow, you can run your hugo site locally with the following steps:\n\n##### 1. Generate node dependency configuration\n\nNow run the following command to generate node dependency configuration. This will create the a `package.json` file in you repo.\n\n```bash\nhugo mod npm pack\n```\n\n##### 2. Install dependencies\n\nInstall the node dependencies using following command:\n```bash\nnpm install\n```\n\n##### 3. Run your site\n\nNow, run you site locally using following command.\n\n```bash\nhugo server -w\n```\n\nWhen you run your site for first time, it will start with the default parameters. It should look similar to the [example site](https://hugo-toha.github.io). However, it will not have any sections in the homepage as we haven't configured them yet. You can configure your site by following the guides from [here](https://toha-guides.netlify.app/posts/configuration/).\n\n## Shortcodes\n\nHere, are some handy shortcodes you can use with this theme.\n\n- [Alert](https://toha-guides.netlify.app/posts/shortcodes/#alert)\n- [Image](https://toha-guides.netlify.app/posts/shortcodes/#image)\n- [Split](https://toha-guides.netlify.app/posts/shortcodes/#split)\n- [Vertical Space](https://toha-guides.netlify.app/posts/shortcodes/#vertical-space)\n- [Video](https://toha-guides.netlify.app/posts/shortcodes/#video)\n- [Mermaid](https://hugo-toha.github.io/posts/shortcodes/#mermaid)\n\n## Contributing\n\nYou can contribute to this theme in various ways. You can report a [bug](https://github.com/hugo-toha/toha/issues/new?template=bug.md), file an [feature request](https://github.com/hugo-toha/toha/issues/new?template=feature_request.md), send a PR, [share your thoughts](https://github.com/hugo-toha/toha/issues/new?template=question.md) etc.\n\nPull requests are most welcome and I will be happy to review. Just follow the following principles:\n\n- Keep it simple.\n- Keep it consistent with the design.\n- Use as few dependencies as possible.\n- Have patience.\n\n\u003e I am not a web developer. I have created this theme for my personal needs. So, it is reasonable to have some flaws in the codes. Feel free to open issues and PRs acknowledging the problems.\n\n## Local Development\n\nFor local development, you can make changes in the theme submodule and test the changes against your own site or this [example site](https://github.com/hugo-toha/hugo-toha.github.io) locally.\n\n### Fork\n\nAt first, fork [this repo](https://github.com/hugo-toha/toha). Then, follow the following steps to use the forked theme for local developments,\n\n#### Running the forked theme against the example site\n\nIf your want to run your local development against this [example site](https://github.com/hugo-toha/hugo-toha.github.io), follow the following steps:\n\n```bash\n# go to exampleSite directory\n$ cd exampleSite\n# install hugo modules\n$ hugo mod tidy\n# install dependencies\n$ hugo mod npm pack\n$ npm install\n# run the example site locally\n$ hugo server -w\n```\n\nNow, you can make change in the theme and they will be reflected immediately on the running site. If you need to change any configuration, you can do that in the `hugo.yaml` file inside `exampleSite` folder. If you need to add any content or data, you can create the respective folder inside `exampleSite` directory and add your desired content or data there.\n\n#### Running the forked theme against your own site\n\nIf you want to run your local development against your own site, follow the following steps:\n\n**Replace the theme module:**\n\nOpen your site's `go.mod` file and replace the `github.com/hugo-toha/toha/v4` with your forked repo's path. For example, if your forked repo is `github.com/\u003cyour-github-user\u003e/toha`, then replace the `github.com/hugo-toha/toha/v4` with `github.com/\u003cyour-github-user\u003e/toha/v4`.\n\n```go\nmodule github.com/hugo-toha/hugo-toha.github.io\n\ngo 1.19\n\nrequire github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect\n\nreplace(\n    github.com/hugo-toha/toha/v4 =\u003e github.com/\u003cyour-github-user\u003e/toha/v4 \u003cgit branch\u003e\n)\n```\n\nFor interactive development, you can replace the theme with your locally cloned fork. For example, if you have cloned your fork in `/home/my-projects/toha`, then replace the `github.com/hugo-toha/toha/v4` with `/home/my-projects/toha`.\n\n```go\nmodule github.com/hugo-toha/hugo-toha.github.io\n\ngo 1.19\n\nrequire github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect\n\nreplace(\n    github.com/hugo-toha/toha/v4 =\u003e /home/my-projects/toha\n)\n```\n\n**Update dependencies:**\n\n```bash\n# update hugo modules\n$ hugo mod tidy\n# install dependencies\n$ hugo mod npm pack\n$ npm install\n```\n\n**Run your site locally:**\n\n```bash\n$ hugo server -w\n```\n\nFrom there you can make changes to the source code of the theme while testing with your running Hugo site or the example site.\n\n### Open a PR\n\nWhen the changes look good, commit and push them to your fork.\n\n```bash\n# stage all the changes\n$ git add .\n# commit the changes with a meaning full commit message\n$ git commit -m \"A meaningful commit message\"\n# push the commit to your fork\n$ git push my-fork my-feature-branch\n```\n\nThen, open a PR against `main` branch of [hugo-toha/toha](https://github.com/hugo-toha/toha) from the `my-feature-branch` branch of your own fork.\n\n## Attribution\n\n- Thanks [Anup Deb](https://dribbble.com/anupdeb) for his design guidance.\n- Many of the illustrations have been taken from [iconscout](http://iconscout.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugo-toha%2Ftoha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugo-toha%2Ftoha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugo-toha%2Ftoha/lists"}