Skip to content

Commit 05551d7

Browse files
jitinnair1jitinnair1
committed
Updates from Overleaf
1 parent 7ee6c4c commit 05551d7

File tree

5 files changed

+110
-23
lines changed

5 files changed

+110
-23
lines changed

‎.github/workflows/build.yml‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
FILE: cv
1212
steps:
1313
- name: Set up Git repository
14-
uses: actions/checkout@v2
14+
uses: actions/checkout@v4
1515
- name: cv
1616
uses: dante-ev/latex-action@latest
1717
with:
@@ -20,7 +20,7 @@ jobs:
2020
- name: move
2121
run: mkdir -p github_artifacts && mv ${{ env.DIR }}/${{ env.FILE }}.pdf ./github_artifacts/
2222
- name: Upload pdf as artifact
23-
uses: actions/upload-artifact@v2
23+
uses: actions/upload-artifact@v4
2424
with:
2525
name: ${{ env.FILE }}.pdf
2626
path: ./github_artifacts
@@ -29,17 +29,29 @@ jobs:
2929
runs-on: ubuntu-latest
3030
steps:
3131
- name: Checkout
32-
uses: actions/checkout@v2
33-
- uses: actions/download-artifact@v2
32+
uses: actions/checkout@v4
33+
- uses: actions/download-artifact@v4
3434
with:
3535
path: github_artifacts
3636
- name: move
3737
run: mkdir -p github_deploy && mv github_artifacts/*/* github_deploy
3838
- name: deploy on orphan branch
39-
uses: peaceiris/actions-gh-pages@v3
39+
uses: peaceiris/actions-gh-pages@v4
4040
with:
4141
github_token: ${{ secrets.GITHUB_TOKEN }}
4242
publish_dir: ./github_deploy
4343
publish_branch: build
4444
force_orphan: true
4545
enable_jekyll: true
46+
copy-index-to-build:
47+
needs: [deploy]
48+
runs-on: ubuntu-latest
49+
steps:
50+
- uses: actions/checkout@v4
51+
with:
52+
fetch-depth: 0
53+
- name: Copy To Branches Action
54+
uses: planetoftheweb/[email protected]
55+
env:
56+
key: main
57+
files: index.html CNAME

‎Makefile‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
NAME=cv
2+
3+
all:
4+
latexmk -pdf ${NAME}.tex
5+
6+
clean:
7+
rm -f ${NAME}.aux ${NAME}.bbl ${NAME}.bcf ${NAME}.fdb_latexmk ${NAME}.fls ${NAME}.log ${NAME}.out ${NAME}.run.xml ${NAME}.blg ${NAME}.toc *\~
8+
9+
distclean: clean
10+
rm -f ${NAME}.pdf

‎README.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,44 @@ The template is designed to be clean with sections for
1111

1212
## Quickstart
1313
- Fork this repo (you can use the `Use this template` button)
14+
- Give the workflow write permissions for your forked repo (Settings -> Actions -> General)
1415
- Modify the `cv.tex` file and push changes to your repo
16+
- Set GitHub pages source to build branch (Settings -> Pages)
1517
- The complied PDF will be available under the `build` branch
1618

17-
Optionally, while forking this repo, you can get a direct link to the generated PDF which you can use on your website, LinkedIn etc. that will always point to the latest version of your CV. For this, after editing your copy of `cv.tex` and pushing changes to your repo, under Settings -> Pages set your Github Pages source to the `build` directory
19+
You can get a direct link to the generated PDF which you can use on your website, LinkedIn etc. that will always point to the latest version of your CV. Once your site is published, your CV will be accessible at: `https://username.github.io/repo-name/`
20+
21+
NOTE: For the direct link to work, after editing your copy of `cv.tex` and pushing changes to your repo, under Settings -> Pages set your Github Pages source to the `build` directory
1822

1923
![](https://i.imgur.com/lwATw1o.png)
2024

21-
Now, once your site is published, your CV will be accessible at: https://username.github.io/autoCV/cv.pdf
25+
## This template on Overleaf
26+
27+
<a href="https://www.overleaf.com/latex/templates/autocv/scfvqfpxncwb"><img alt="Overleaf" src="https://img.shields.io/badge/Overleaf-47A141.svg?style=for-the-badge&logo=Overleaf&logoColor=white"/></a>
28+
29+
Also, if you have a premium subscription to Overleaf, you can use Overleaf's GitHub integration to push changes to your GitHub repo directly from Overleaf.
30+
31+
## Compiling the CV on your local computer
32+
- type `make` in the `autoCV` directory to produce file `cv.pdf`
33+
- you can optionally type `make clean` or `make distclean` to remove intermediate files
2234

2335
## Detailed Instructions..
2436

2537
[.. are available here](https://github.com/jitinnair1/autoCV/wiki/How-to-use-autoCV:-Detailed-Instructions)
2638

39+
## More options
40+
- If you'd like a custom URL like `cv.name.com` check out [this page](https://github.com/jitinnair1/autoCV/wiki/Custom-URL-for-your-CV)
41+
- If you want to add use different versions of the CV for different langauges, you can modify the script [as seen here](https://github.com/MateusRosario/myAutoCV/blob/main/.github/workflows/build.yml) (from Mateus Rosario's [fork](https://github.com/MateusRosario/myAutoCV) of this repo)
42+
2743
## Issues
2844
Please start a new discussion or issue if you encounter problems
45+
46+
PS: If you liked the template, do star :star: it! Thanks!
47+
48+
49+
### Also, check out:
50+
51+
- [gradfolio](https://github.com/jitinnair1/gradfolio) - a minimal, quick-setup template for a personal website/portfolio
52+
- [Tail](https://github.com/jitinnair1/tail) - a minimal, quick-setup template for a blog
53+
- [snippet-book](https://github.com/jitinnair1/snippet-book) -terminal style, clean Jekyll blog theme with catppuccin colours
54+

‎cv.tex‎

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,32 @@
9797
%debug page outer frames
9898
%\usepackage{showframe}
9999

100+
101+
% job listing environments
102+
\newenvironment{jobshort}[2]
103+
{
104+
\begin{tabularx}{\linewidth}{@{}l X r@{}}
105+
\textbf{#1} & \hfill & #2 \\[3.75pt]
106+
\end{tabularx}
107+
}
108+
{
109+
}
110+
111+
\newenvironment{joblong}[2]
112+
{
113+
\begin{tabularx}{\linewidth}{@{}l X r@{}}
114+
\textbf{#1} & \hfill & #2 \\[3.75pt]
115+
\end{tabularx}
116+
\begin{minipage}[t]{\linewidth}
117+
\begin{itemize}[nosep,after=\strut, leftmargin=1em, itemsep=3pt,label=--]
118+
}
119+
{
120+
\end{itemize}
121+
\end{minipage}
122+
}
123+
124+
125+
100126
%----------------------------------------------------------------------------------------
101127
% BEGIN DOCUMENT
102128
%----------------------------------------------------------------------------------------
@@ -130,28 +156,21 @@
130156

131157
%Interests/ Keywords/ Summary
132158
\section{Summary}
133-
This CV is automatically generated and deployed using the \href{https://github.com/jitinnair1/autoCV}{autoCV} template along with GitHub Actions such that a new version of the CV is compiled, published and ready for use when the cv.tex file is updated. For details, \href{https://github.com/jitinnair1/autoCV}{click here}.
159+
This CV can also be automatically complied and published using GitHub Actions. For details, \href{https://github.com/jitinnair1/autoCV}{click here}.
134160

135161
%Experience
136162
\section{Work Experience}
137163

138-
\begin{tabularx}{\linewidth}{ @{}l r@{} }
139-
\textbf{Designation} & \hfill Jan 2021 - present \\[3.75pt]
140-
\multicolumn{2}{@{}X@{}}{long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width} \\
141-
\end{tabularx}
164+
\begin{jobshort}{Designation}{Jan 2021 - present}
165+
long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width long long line of blah blah that will wrap when the table fills the column width
166+
\end{jobshort}
142167

143-
\begin{tabularx}{\linewidth}{ @{}l r@{} }
144-
\textbf{Designation} & \hfill Mar 2019 - Jan 2021 \\[3.75pt]
145-
\multicolumn{2}{@{}X@{}}{
146-
\begin{minipage}[t]{\linewidth}
147-
\begin{itemize}[nosep,after=\strut, leftmargin=1em, itemsep=3pt]
148-
\item[--] long long line of blah blah that will wrap when the table fills the column width
149-
\item[--] again, long long line of blah blah that will wrap when the table fills the column width but this time even more long long line of blah blah. again, long long line of blah blah that will wrap when the table fills the column width but this time even more long long line of blah blah
150-
\end{itemize}
151-
\end{minipage}
152-
}
153-
\end{tabularx}
154168

169+
\begin{joblong}{Designation}{Mar 2019 - Jan 2021}
170+
\item long long line of blah blah that will wrap when the table fills the column width
171+
\item again, long long line of blah blah that will wrap when the table fills the column width but this time even more long long line of blah blah. again, long long line of blah blah that will wrap when the table fills the column width but this time even more long long line of blah blah
172+
\end{joblong}
173+
155174
%Projects
156175
\section{Projects}
157176

‎index.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en-US">
3+
<head>
4+
<meta charset="UTF-8">
5+
6+
<!--You can add your name and affiliation below to personalise -->
7+
<meta property="og:title" content="My CV"/>
8+
9+
<!--You can add your keywords to personalise-->
10+
<meta property="og:description" content="Education, Experience, Projects etc."/>
11+
12+
<meta property="og:image" content="https://dummyimage.com/100x100/000/fff&text=CV" />
13+
<title>CV</title>
14+
</head>
15+
<body>
16+
<script type="text/javascript">
17+
window.location.href = "./cv.pdf"
18+
</script>
19+
</body>
20+
</html>

0 commit comments

Comments
 (0)