https://github.com/riyadhuddin/portfolio
Used as submodule to
https://github.com/riyadhuddin/portfolio
hugo portfolio
Last synced: about 1 year ago
JSON representation
Used as submodule to
- Host: GitHub
- URL: https://github.com/riyadhuddin/portfolio
- Owner: riyadhuddin
- License: mit
- Created: 2021-12-12T08:50:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-13T10:45:15.000Z (over 4 years ago)
- Last Synced: 2025-01-22T15:30:46.053Z (over 1 year ago)
- Topics: hugo, portfolio
- Language: HTML
- Homepage: https://github.com/riyadhuddin/hugo-portfolio
- Size: 3.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# portfolio
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FRiyadhUddin%2Fportfolio) [](https://github.com/RiyadhUddin/portfolio/network) [](https://github.com/RiyadhUddin/portfolio/stargazers)
[](https://app.netlify.com/sites/riyadhuddin/deploys)
A high performance and mobile first hugo template for personal portfolio and blog
### Credit
https://github.com/gurusabarish/hugo-profile
### Demo
- [Live demo V1](https://riyadhuddin.netlify.app/)
## Requirements
- Hugo Version 0.68.0 or higher
## How to use this template
- [portfolio](#portfolio)
- [Credit](#credit)
- [Demo](#demo)
- [Requirements](#requirements)
- [How to use this template](#how-to-use-this-template)
- [Hugo theme format](#hugo-theme-format)
- [Local Development](#local-development)
- [Direct deployment using netlify](#direct-deployment-using-netlify)
- [Direct deployment using Github Pages and action](#direct-deployment-using-github-pages-and-action)
- [Deployment](#deployment)
- [Issues](#issues)
- [Contributing](#contributing)
- [License](#license)
### Hugo theme format
- Install Hugo and create a site using `hugo new site my-site -f=yaml`
- Clone this repo inside your themes folder and create config.yaml (_I am not much aware about toml. So, I am using yaml format._) inside root folder and use one of these [v1config](https://github.com/RiyadhUddin/portfolio/blob/master/website/v1.yaml), [v2config](https://github.com/RiyadhUddin/portfolio/blob/master/website/v2.yaml), [v3config](https://github.com/RiyadhUddin/portfolio/blob/master/website/v3.yaml) as base template.
```
cd themes
git clone https://github.com/riyadhUddin/portfolio.git
```
- You should have the mentioned (_inside the config file_) images in static folder to use them.
### Local Development
- Install hugo and just clone this repo
```
git clone https://github.com/RiyadhUddin/portfolio.git
cd portfolio
```
- Now create config.yaml file in your root folder and use one of these [v1config](https://github.com/riyadhUddin/portfolio/blob/master/website/v1.yaml), [v2config](https://github.com/riyadhUddin/portfolio/blob/master/website/v2.yaml), [v3config](https://github.com/riyadhUddin/portfolio/blob/master/website/v3.yaml) as base template.
- Run your site using `hugo serve` commend
### Direct deployment using netlify
- Fork this repo or create new repo using `use this template` button and connect repo to netlify.
- You can customize the config file, content and everything inside website folder. Netlify will automatically deploy your changes every time you modify the repo.
**[What is netlify?](https://www.netlify.com/about/)** An intuitive Git-based workflow and powerful serverless platform to build, deploy, and collaborate on web apps
### Direct deployment using Github Pages and action
- Fork this repo or create new repo using `use this template` button. Github action will generate all files and push to demo branch. Now, you have to connect your github pages to that `demo` branch. _No need to create demo branch. Github action will take care of it_
- You can customize the config file, content and everything inside website folder. Github action will automatically deploy your changes to demo branch every time you modify the repo.
## Deployment
Run `hugo`. It will generate a folder called public. You can use the files inside public folder for deployment. You should delete the public folder for each time when you are using `hugo` commend.
## Issues
If you have a question, please [open an issue](https://github.com/gurusabarish/hugo-profile/issues) for help and to help those who come after you. The more information you can provide, the better!
## Contributing
Contributions, issues, and feature requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
## License
Licensed under [MIT](LICENSE)