Git Product home page Git Product logo

fastcv's Introduction

FastCV

image image image

A complete beginner's tutorial shows you how to build your personal cv with hugo and display it using github.io.

Environment

For mac user ๐Ÿ‘‡๐Ÿป
MacOS Ventura 13.2
Hugo version -> hugo v0.110.0+extended darwin/arm64 BuildDate=unknown
For linux user ๐Ÿ‘‡๐Ÿป
Ubuntu 20.04.5 LTS (GNU/Linux 5.4.0-131-generic x86_64)
Hugo version -> Hugo Static Site Generator v0.68.3/extended linux/amd64 BuildDate: 2020-03-25T06:15:45Z For windows user ๐Ÿ‘‡๐Ÿป Windows 11 21H2 22000.376 hugo v0.111.0-3fa8bb8318114cd69315eadd35bda169e6a8ca4b+extended windows/amd64 BuildDate=2023-03-01T20:57:44Z VendorInfo=gohugoio

Get start

Windows

If you are a windows user, please install chocolatey and git first. how-to-use-chocolatey-choco-to-install-git-on-windows. Then choose a directory to open git-bash. Then execute the following command.

$ sh build-windows-x86_64.sh

Automate the local build process (suggested)

If you want to skip the git-tools installation chapter and hugo installation chapter and local build chapter, then execute the following command.

$ chmod +x build-macos-arm_64.sh # If you are a linux user please try build-linux-x86_64.sh
$ echo "hugo server --source hugoServer/mycv" >> build-macos-arm_64.sh
$ ./build-macos-arm_64.sh

After executing this build script, please jump directly to step-configure-ssh and step-create-repository. Then jump to step-deploy.

Install Git

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.

Install homebrew

Homebrew is a free and open source package management system that simplifies the installation of software on macOS systems.

# When you execute the command plz remove '$' first.
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Adding the ssh key is for our later operations to go on smoothly.

$ cd ~/.ssh # If you don't have this folder, please google for how to generate ssh key.
$ ls
id_rsa		id_rsa.pub ...
$ cat id_rsa.pub # Copy all your output.
.
.
.

Access your github account settings page. (ps:If you are already logged in then just click -> link) 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.

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".

Install hugo

$ brew install hugo
$ hugo version # Success if version output is available
...

Build our cv locally

$ mkdir hugoServer
$ hugo new site hugoServer/mycv
$ git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4
$ cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/
$ cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/
$ rm hugoServer/mycv/config.toml # using config.yaml as our config file
$ hugo server --source hugoServer/mycv --disableFastRender # Now you can check your hugo-server is working locally by access http://localhost:1313/ .
$ hugo --source hugoServer/mycv -D
$ cd hugoServer/mycv/public
$ git init
$ git remote add origin [email protected]:your_account_name/your_account_name.github.io.git
$ git pull origin main
$ git checkout main # Make sure you are on the main branch.
$ git add .
$ git commit -m "first commit"
$ git push -u origin main
...
# Now you can view your cv by visiting your_account_name.github.io

Workflow to edit this cv

Edit these two files. See what has changed by using the local hugo server.

$ ls # Now back to our root directory.
.
โ”œโ”€โ”€ archetypes
โ”œโ”€โ”€ config.yaml # ๐Ÿ‘ˆ๐Ÿป This is a configuration file where you can configure.
โ”œโ”€โ”€ content
โ”œโ”€โ”€ data # ๐Ÿ‘ˆ๐Ÿป Your cv details are all in this folder.
โ”‚   โ”œโ”€โ”€ education.yaml 
โ”‚   โ”œโ”€โ”€ experience.yaml
โ”‚   โ”œโ”€โ”€ features.yaml
โ”‚   โ”œโ”€โ”€ projects.yaml
โ”‚   โ””โ”€โ”€ publications.yaml
โ”œโ”€โ”€ layouts
โ”œโ”€โ”€ public
โ”œโ”€โ”€ resources
โ”œโ”€โ”€ static
โ””โ”€โ”€ themes

When you have edited any one or more of these two files and you want to change the content displayed on github.io.

$ ls # First back to our root directory. 
.
โ”œโ”€โ”€ archetypes
โ”œโ”€โ”€ config.yaml
โ”œโ”€โ”€ content
โ”œโ”€โ”€ data
โ”œโ”€โ”€ layouts
โ”œโ”€โ”€ public
โ”œโ”€โ”€ resources
โ”œโ”€โ”€ static
โ””โ”€โ”€ themes
# Then run ๐Ÿ‘‡๐Ÿป
$ hugo -D
$ cd public
$ git checkout main
$ git add .
$ git commit -m "cv updated"
$ git push
# Now you can view your changes by visiting your_account_name.github.io

Hugo Theme we use

Thanks to resume-a4. If you need more details about Hugo Themes, please check out HugoThemes.

fastcv's People

Contributors

mgmcn avatar kabuda-czh avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.