A Hugo theme for a personal portfolio with minimalist design and responsiveness.
For more details about the features please visit here.
Here are few screenshots from the example site.
In order to use this theme, follow the following steps:
At first, add Toha theme as git submodule to your hugo-site.
$ git submodule add https://github.com/hugo-toha/toha.git themes/toha
Don't use SSH URL of the theme during adding as git sub-module. Also, don't clone the theme in your
git clone. They don't work well with Github Action or Netlify.
If you don't already have a hugo site, create one by following the step-by-step guide from here.
Now, configure your site to use
toha theme by adding the following configuration in
config.yaml file of your site.
Don't forget to update
gitRepo fields with your own information. To know about more available configuration options, please visit here.
Now, you can run your hugo site with
toha theme locally with the following command:
$ hugo server --theme toha --watch
When you run your site for first time, it will start with the default parameters. It should look similar to the example site. 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.
Here, are some handy shortcodes you can use with this theme.
Here, are the current plan and progress of various components of this theme. The components will be prioritized based on users requests.
Here is the check list for portfolio mode,
[x] Recent Posts
[x] Academic Career
[ ] Publications
[x] Accomplishment / Courses
[x] Achievements Gallery
Here is the checklist for blog mode,
[ ] Dedicated Home page
[x] List Page
[x] Reading Page
Improve This PageButton
Here is the check list for documentation mode,
Pull requests are most welcome and I will be happy to review. Just follow the following principles:
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.
For local development, you can make changes in the theme submodule and test the changes against your own site or this example site locally.
At first, fork this repo. Then, follow the following steps to use the forked theme for local developments,
Using the forked theme in your own site:
If you want to run your local development against your own site, follow the following steps:
# add the original theme as a submodule of your site if you haven't done already $ git submodule add https://github.com/hugo-toha/toha.git themes/toha # navigate into the toha theme folder $ cd themes/toha # add your own fork as a remote $ git remote add my-fork https://github.com/<your-github-user>/toha # create a new branch for your changes $ git checkout -b my-feature-branch
Using the forked theme in the example site:
If your want to run your local development against this example site, follow the following steps:
# clone the example site along with the submodules $ git clone [email protected]:hugo-toha/hugo-toha.github.io.git --recursive # navigate into the toha theme folder $ cd themes/toha # add your own fork as a remote $ git remote add my-fork https://github.com/<your-github-user>/toha # create a new branch for your changes $ git checkout -b my-feature-branch
From there you can make changes to the source code of the theme while testing with your running Hugo site or the example site.
When the changes look good, commit and push them to your fork.
# stage all the changes $ git add . # commit the changes with a meaning full commit message $ git commit -m "A meaningful commit message" # push the commit to your fork $ git push my-fork my-feature-branch
Then, open a PR against
main branch of hugo-toha/toha from the
my-feature-branch branch of your own fork.