├── .github └── workflows │ └── actions.yml ├── .gitignore ├── LICENSE ├── README.md ├── build-linux-x86_64.sh ├── build-macos-arm_64.sh ├── build-windows-x86_64.sh ├── images ├── add_sshkey.jpg └── create_repo.jpg └── resume-a4.zip /.github/workflows/actions.yml: -------------------------------------------------------------------------------- 1 | name: Hugo test 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | test_for_build_our_cv_on_MacOS: 13 | timeout-minutes: 10 14 | runs-on: macos-latest 15 | 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v3 19 | 20 | - name: Run build 21 | run: | 22 | chmod +x build-macos-arm_64.sh 23 | ./build-macos-arm_64.sh 24 | 25 | test_for_build_our_cv_on_LinuxUbuntu: 26 | timeout-minutes: 10 27 | runs-on: ubuntu-20.04 28 | 29 | steps: 30 | - name: Checkout 31 | uses: actions/checkout@v3 32 | 33 | - name: Run build 34 | run: | 35 | chmod +x build-linux-x86_64.sh 36 | ./build-linux-x86_64.sh 37 | 38 | test_for_build_our_cv_on_Windows: 39 | timeout-minutes: 10 40 | runs-on: windows-latest 41 | 42 | steps: 43 | - name: Checkout 44 | uses: actions/checkout@v3 45 | 46 | - name: Choco Choco 47 | uses: crazy-max/ghaction-chocolatey@v2 48 | with: 49 | args: -h 50 | 51 | - name: Run build 52 | run: | 53 | sh build-windows-x86_64.sh 54 | 55 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # MacOS 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Takayama 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FastCV 2 | ![image](https://img.shields.io/github/actions/workflow/status/MGMCN/FastCV/actions.yml?logo=github) 3 | ![image](https://img.shields.io/github/last-commit/MGMCN/FastCV?logo=github) 4 | ![image](https://img.shields.io/github/license/MGMCN/FastCV) 5 | 6 | A complete beginner's tutorial shows you how to build your personal cv with [hugo](https://github.com/gohugoio/hugo) and display it using [github.io](https://docs.github.com/en/pages). 7 | ## Environment 8 | > For mac user 👇🏻 9 | > MacOS Ventura 13.2 10 | > Hugo version -> Hugo v0.110.0+extended darwin/arm64 11 | > For linux user 👇🏻 12 | > Ubuntu 20.04.5 LTS (GNU/Linux 5.4.0-131-generic x86_64) 13 | > Hugo version -> Hugo Static Site Generator v0.68.3/extended linux/amd64 14 | > For windows user 👇🏻 15 | > Windows 11 21H2 22000.376 16 | > Hugo version -> Hugo v0.111.0+extended windows/amd64 17 | # Get start 18 | ## Automate the local build process (suggested) 19 | If you want to automate the local build of your cv, execute the following command. 20 | ### Windows 21 | If you are a windows user, please install chocolatey and git first. See -> [how-to-use-chocolatey-choco-to-install-git-on-windows](https://www.geeksforgeeks.org/how-to-use-chocolatey-choco-to-install-git-on-windows/). 22 | Then choose a directory to open git-bash and find build-windows-x86_64.sh of this project that you clone. 23 | Execute the following command to build your cv locally. 24 | ```Bash 25 | # When you execute the command plz remove '$' first. 26 | $ echo "hugo server --source hugoServer/mycv" >> build-windows-x86_64.sh 27 | $ sh build-windows-x86_64.sh 28 | ``` 29 | If your git-bash is already configured with ssh access to your github, then you can jump directly to [step-create-repository](#createrepository) and [step-deploy](#deploy). 30 | ### MacOS & Linux_Ubuntu 31 | ```Bash 32 | # When you execute the command plz remove '$' first. 33 | $ chmod +x build-macos-arm_64.sh # If you are a linux user please try build-linux-x86_64.sh 34 | $ echo "hugo server --source hugoServer/mycv" >> build-macos-arm_64.sh 35 | $ ./build-macos-arm_64.sh 36 | ``` 37 | After executing this build script, please jump directly to [step-configure-ssh](#configuressh) and [step-create-repository](#createrepository). Then jump to [step-deploy](#deploy). 38 | ## Install Git 39 | For most people who use github, I assume they have git installed correctly. But if you are new to github and don't have git installed, plz check out [link](https://git-scm.com/download/mac). 40 | ## Install homebrew 41 | Homebrew is a free and open source package management system that simplifies the installation of software on macOS systems. 42 | ```Bash 43 | $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" 44 | ``` 45 | ## Install hugo 46 | ```Bash 47 | $ brew install hugo 48 | $ hugo version # Success if version output is available 49 | ... 50 | ``` 51 | ## Configure SSH key for github 52 | Adding the ssh key is for our later operations to go on smoothly. 53 | ```Bash 54 | $ cd ~/.ssh # If you don't have this folder, please google for how to generate ssh key. 55 | $ ls 56 | id_rsa id_rsa.pub ... 57 | $ cat id_rsa.pub # Copy all your output. 58 | . 59 | . 60 | . 61 | ``` 62 | Access your github account settings page. (ps:If you are already logged in then just click -> [link](https://github.com/settings/keys)) Find option called SSH key and GPG keys. Create SSH key like 👇🏻. Put the text of the id_rsa.pub you copied into the place of the key below. 63 | 64 | 65 | 66 | ## Create a repository for your cv 67 | Notice: repository name should be like your_account_name.github.io. When you visit your github homepage, the string at the end of your link is your_account_name. For me the link is "https://github.com/MGMCN". So my_account_name is "MGMCN". 68 | 69 | 70 | 71 | ## Build our cv locally 72 | ```Bash 73 | $ mkdir hugoServer 74 | $ hugo new site hugoServer/mycv 75 | $ git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4 76 | $ cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/ 77 | $ cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/ 78 | $ rm hugoServer/mycv/config.toml # using config.yaml as our config file 79 | $ hugo server --source hugoServer/mycv --disableFastRender # Now you can check your hugo-server is working locally by access http://localhost:1313/ . 80 | ``` 81 | ## Deploy our cv to github.io 82 | ```Bash 83 | $ hugo --source hugoServer/mycv -D 84 | $ cd hugoServer/mycv/public 85 | $ git init 86 | $ git remote add origin git@github.com:your_account_name/your_account_name.github.io.git 87 | $ git pull origin main 88 | $ git checkout main # Make sure you are on the main branch. 89 | $ git add . 90 | $ git commit -m "first commit" 91 | $ git push -u origin main 92 | ... 93 | # Now you can view your cv by visiting your_account_name.github.io 94 | ``` 95 | ## Workflow to edit this cv 96 | Edit these two files. See what has changed by using the local hugo server. 97 | ```Bash 98 | $ ls # Now back to our root directory. 99 | . 100 | ├── archetypes 101 | ├── config.yaml # 👈🏻 This is a configuration file where you can configure. 102 | ├── content 103 | ├── data # 👈🏻 Your cv details are all in this folder. 104 | │ ├── education.yaml 105 | │ ├── experience.yaml 106 | │ ├── features.yaml 107 | │ ├── projects.yaml 108 | │ └── publications.yaml 109 | ├── layouts 110 | ├── public 111 | ├── resources 112 | ├── static 113 | └── themes 114 | ``` 115 | When you have edited any one or more of these two files and you want to change the content displayed on github.io. 116 | ```Bash 117 | $ ls # First back to our root directory. 118 | . 119 | ├── archetypes 120 | ├── config.yaml 121 | ├── content 122 | ├── data 123 | ├── layouts 124 | ├── public 125 | ├── resources 126 | ├── static 127 | └── themes 128 | # Then run 👇🏻 129 | $ hugo -D 130 | $ cd public 131 | $ git checkout main 132 | $ git add . 133 | $ git commit -m "cv updated" 134 | $ git push 135 | # Now you can view your changes by visiting your_account_name.github.io 136 | ``` 137 | ## Hugo Theme we use 138 | Thanks to [resume-a4](https://themes.gohugo.io/themes/resume-a4/). If you need more details about Hugo Themes, please check out [HugoThemes](https://themes.gohugo.io/). ( ps: To make sure that the resume theme is not inaccessible, I have also added an [archive file](https://github.com/MGMCN/FastCV/blob/main/resume-a4.zip). ) 139 | -------------------------------------------------------------------------------- /build-linux-x86_64.sh: -------------------------------------------------------------------------------- 1 | sudo apt update; 2 | sudo apt upgrade; 3 | sudo apt install git; 4 | sudo apt install hugo; 5 | mkdir hugoServer; 6 | hugo new site hugoServer/mycv; 7 | git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4; 8 | cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/; 9 | cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/; 10 | rm hugoServer/mycv/config.toml; 11 | hugo --source hugoServer/mycv -D; 12 | -------------------------------------------------------------------------------- /build-macos-arm_64.sh: -------------------------------------------------------------------------------- 1 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"; 2 | brew install git; 3 | brew install hugo; 4 | mkdir hugoServer; 5 | hugo new site hugoServer/mycv; 6 | git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4; 7 | cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/; 8 | cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/; 9 | rm hugoServer/mycv/config.toml; 10 | hugo --source hugoServer/mycv -D; 11 | -------------------------------------------------------------------------------- /build-windows-x86_64.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | choco install hugo-extended -confirm; 3 | mkdir hugoServer; 4 | hugo new site hugoServer/mycv; 5 | git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4; 6 | cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/; 7 | cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/; 8 | rm hugoServer/mycv/config.toml; 9 | hugo --source hugoServer/mycv -D; -------------------------------------------------------------------------------- /images/add_sshkey.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGMCN/FastCV/5346c19ab441d8a5ea8151f3e723833754d3692f/images/add_sshkey.jpg -------------------------------------------------------------------------------- /images/create_repo.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGMCN/FastCV/5346c19ab441d8a5ea8151f3e723833754d3692f/images/create_repo.jpg -------------------------------------------------------------------------------- /resume-a4.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MGMCN/FastCV/5346c19ab441d8a5ea8151f3e723833754d3692f/resume-a4.zip --------------------------------------------------------------------------------