Skip to content

Commit

Permalink
Deploying to gh-pages from @ b62f46d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
kazuyanagimoto committed Apr 25, 2024
1 parent bb3d467 commit a018080
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 32 deletions.
Binary file modified freeze.rds
Binary file not shown.
59 changes: 32 additions & 27 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -288,22 +288,27 @@ <h2 class="anchored" data-anchor-id="installation">Installation</h2>
</section>
<section id="usage" class="level2">
<h2 class="anchored" data-anchor-id="usage">Usage</h2>
<p>You can find a simple <a href="vignettes/typstcv.pdf">example</a> and <a href="https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/typstcv.qmd">qmd</a> code.</p>
<p>You can find a simple <a href="https://kazuyanagimoto.com/typstcv/vignettes/typstcv.pdf">example</a> and <a href="https://github.com/kazuyanagimoto/typstcv/blob/main/vignettes/typstcv.qmd">qmd</a> code.</p>
<section id="use-template" class="level3">
<h3 class="anchored" data-anchor-id="use-template">Use Template</h3>
<p>You can use the template with <code>quarto</code> command.</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">quarto</span> use template kazuyanagimoto/quarto-awesomecv-typst</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="yaml" class="level3">
<h3 class="anchored" data-anchor-id="yaml">YAML</h3>
<p>Set author information in YAML.</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">author</span><span class="kw">:</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">firstname</span><span class="kw">:</span><span class="at"> Albert</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">lastname</span><span class="kw">:</span><span class="at"> Einstein</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">address</span><span class="kw">:</span><span class="at"> </span><span class="st">"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich"</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">positions</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"Research Physicist"</span><span class="kw">,</span><span class="at"> </span><span class="st">"Professor"</span><span class="kw">]</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">contacts</span><span class="kw">:</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">icon</span><span class="kw">:</span><span class="at"> fa envelope</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">text</span><span class="kw">:</span><span class="at"> ae@example.com</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> </span><span class="st">"mailto:ae@example.com"</span></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">icon</span><span class="kw">:</span><span class="at"> PATH_TO_ICON/icon.svg</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">text</span><span class="kw">:</span><span class="at"> example.com</span></span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://example.com</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb3"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">author</span><span class="kw">:</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">firstname</span><span class="kw">:</span><span class="at"> Albert</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">lastname</span><span class="kw">:</span><span class="at"> Einstein</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">address</span><span class="kw">:</span><span class="at"> </span><span class="st">"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich"</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">positions</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"Research Physicist"</span><span class="kw">,</span><span class="at"> </span><span class="st">"Professor"</span><span class="kw">]</span></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">contacts</span><span class="kw">:</span></span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">icon</span><span class="kw">:</span><span class="at"> fa envelope</span></span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">text</span><span class="kw">:</span><span class="at"> ae@example.com</span></span>
<span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> </span><span class="st">"mailto:ae@example.com"</span></span>
<span id="cb3-10"><a href="#cb3-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">icon</span><span class="kw">:</span><span class="at"> PATH_TO_ICON/icon.svg</span></span>
<span id="cb3-11"><a href="#cb3-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">text</span><span class="kw">:</span><span class="at"> example.com</span></span>
<span id="cb3-12"><a href="#cb3-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">url</span><span class="kw">:</span><span class="at"> https://example.com</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ul>
<li><a href="https://fontawesome.com/search?m=free&amp;o=r">fontawesome</a> icons are supported via <a href="https://github.com/duskmoon314/typst-fontawesome">duskmoon314/typst-fontawesome</a> with <code>fa</code> prefix.</li>
<li>SVG icons can be used by specifying the path to the icon file</li>
Expand All @@ -312,24 +317,24 @@ <h3 class="anchored" data-anchor-id="yaml">YAML</h3>
<section id="fonts-color" class="level3">
<h3 class="anchored" data-anchor-id="fonts-color">Fonts &amp; Color</h3>
<p>You can set fonts and the accent color in YAML.</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">style</span><span class="kw">:</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">color-accent</span><span class="kw">:</span><span class="at"> </span><span class="st">"516db0"</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-header</span><span class="kw">:</span><span class="at"> </span><span class="st">"Roboto"</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-text</span><span class="kw">:</span><span class="at"> </span><span class="st">"Source Sans Pro"</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="fu">format</span><span class="kw">:</span></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">awesomecv-typst</span><span class="kw">:</span></span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-paths</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"PATH_TO_FONT"</span><span class="kw">]</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb4"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="fu">style</span><span class="kw">:</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">color-accent</span><span class="kw">:</span><span class="at"> </span><span class="st">"516db0"</span></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-header</span><span class="kw">:</span><span class="at"> </span><span class="st">"Roboto"</span></span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-text</span><span class="kw">:</span><span class="at"> </span><span class="st">"Source Sans Pro"</span></span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="fu">format</span><span class="kw">:</span></span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">awesomecv-typst</span><span class="kw">:</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">font-paths</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">"PATH_TO_FONT"</span><span class="kw">]</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="resume-entries" class="level3">
<h3 class="anchored" data-anchor-id="resume-entries">Resume Entries</h3>
<p><code>resume_entry()</code> is a helper function to create resume entryies from a data frame.</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a>df_educ <span class="sc">|&gt;</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">resume_entry</span>(</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> <span class="at">title =</span> <span class="st">"title"</span>,</span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> <span class="at">location =</span> <span class="st">"location"</span>,</span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a> <span class="at">date =</span> <span class="st">"year"</span>,</span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a> <span class="at">description =</span> <span class="st">"detail"</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb5"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>df_educ <span class="sc">|&gt;</span></span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a> <span class="fu">resume_entry</span>(</span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a> <span class="at">title =</span> <span class="st">"title"</span>,</span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a> <span class="at">location =</span> <span class="st">"location"</span>,</span>
<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a> <span class="at">date =</span> <span class="st">"year"</span>,</span>
<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a> <span class="at">description =</span> <span class="st">"detail"</span></span>
<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>


</section>
Expand Down
6 changes: 3 additions & 3 deletions search.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"href": "vignettes/gallery.html",
"title": "Gallery",
"section": "",
"text": "Albert Einstein’s CV\n\n\n\n\n\n\nKazuharu Yanagimoto\n\n\nApr 24, 2024\n\n\n\n\n\n\n\n\nNo matching items",
"text": "Albert Einstein’s CV\n\n\n\n\n\n\nKazuharu Yanagimoto\n\n\nApr 25, 2024\n\n\n\n\n\n\n\n\nNo matching items",
"crumbs": [
"Gallery"
]
Expand All @@ -90,7 +90,7 @@
"href": "index.html",
"title": "typstcv",
"section": "",
"text": "This package provides helper functinons for kazuyanagimoto/quarto-awesomecv-typst. This work are inspired by these three works:\n\nByungjin Park’s Awesome-CV\n\nA beautiful \\(\\LaTeX\\) template of CV\n\nPaul Tsouchlos’s modern-cv\n\nA Typst implementation of Awesome-CV\n\nMitchell O’Hara-Wild and Rob Hyndman’s vitae\n\nR package for modern CV, including Awesome-CV\n\n\n\n\nYou can install the development version of typstcv from R-universe with:\ninstall.packages(\"typstcv\", repos = \"https://kazuyanagimoto.r-universe.dev\")\n\n\n\nYou can find a simple example and qmd code.\n\n\nSet author information in YAML.\nauthor:\n firstname: Albert\n lastname: Einstein\n address: \"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich\"\n positions: [\"Research Physicist\", \"Professor\"]\n contacts:\n - icon: fa envelope\n text: ae@example.com\n url: \"mailto:ae@example.com\"\n - icon: PATH_TO_ICON/icon.svg\n text: example.com\n url: https://example.com\n\nfontawesome icons are supported via duskmoon314/typst-fontawesome with fa prefix.\nSVG icons can be used by specifying the path to the icon file\n\n\n\n\nYou can set fonts and the accent color in YAML.\nstyle:\n color-accent: \"516db0\"\n font-header: \"Roboto\"\n font-text: \"Source Sans Pro\"\nformat:\n awesomecv-typst:\n font-paths: [\"PATH_TO_FONT\"]\n\n\n\nresume_entry() is a helper function to create resume entryies from a data frame.\ndf_educ |&gt;\n resume_entry(\n title = \"title\",\n location = \"location\",\n date = \"year\",\n description = \"detail\"\n)",
"text": "This package provides helper functinons for kazuyanagimoto/quarto-awesomecv-typst. This work are inspired by these three works:\n\nByungjin Park’s Awesome-CV\n\nA beautiful \\(\\LaTeX\\) template of CV\n\nPaul Tsouchlos’s modern-cv\n\nA Typst implementation of Awesome-CV\n\nMitchell O’Hara-Wild and Rob Hyndman’s vitae\n\nR package for modern CV, including Awesome-CV\n\n\n\n\nYou can install the development version of typstcv from R-universe with:\ninstall.packages(\"typstcv\", repos = \"https://kazuyanagimoto.r-universe.dev\")\n\n\n\nYou can find a simple example and qmd code.\n\n\nYou can use the template with quarto command.\nquarto use template kazuyanagimoto/quarto-awesomecv-typst\n\n\n\nSet author information in YAML.\nauthor:\n firstname: Albert\n lastname: Einstein\n address: \"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich\"\n positions: [\"Research Physicist\", \"Professor\"]\n contacts:\n - icon: fa envelope\n text: ae@example.com\n url: \"mailto:ae@example.com\"\n - icon: PATH_TO_ICON/icon.svg\n text: example.com\n url: https://example.com\n\nfontawesome icons are supported via duskmoon314/typst-fontawesome with fa prefix.\nSVG icons can be used by specifying the path to the icon file\n\n\n\n\nYou can set fonts and the accent color in YAML.\nstyle:\n color-accent: \"516db0\"\n font-header: \"Roboto\"\n font-text: \"Source Sans Pro\"\nformat:\n awesomecv-typst:\n font-paths: [\"PATH_TO_FONT\"]\n\n\n\nresume_entry() is a helper function to create resume entryies from a data frame.\ndf_educ |&gt;\n resume_entry(\n title = \"title\",\n location = \"location\",\n date = \"year\",\n description = \"detail\"\n)",
"crumbs": [
"Home"
]
Expand All @@ -110,7 +110,7 @@
"href": "index.html#usage",
"title": "typstcv",
"section": "",
"text": "You can find a simple example and qmd code.\n\n\nSet author information in YAML.\nauthor:\n firstname: Albert\n lastname: Einstein\n address: \"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich\"\n positions: [\"Research Physicist\", \"Professor\"]\n contacts:\n - icon: fa envelope\n text: ae@example.com\n url: \"mailto:ae@example.com\"\n - icon: PATH_TO_ICON/icon.svg\n text: example.com\n url: https://example.com\n\nfontawesome icons are supported via duskmoon314/typst-fontawesome with fa prefix.\nSVG icons can be used by specifying the path to the icon file\n\n\n\n\nYou can set fonts and the accent color in YAML.\nstyle:\n color-accent: \"516db0\"\n font-header: \"Roboto\"\n font-text: \"Source Sans Pro\"\nformat:\n awesomecv-typst:\n font-paths: [\"PATH_TO_FONT\"]\n\n\n\nresume_entry() is a helper function to create resume entryies from a data frame.\ndf_educ |&gt;\n resume_entry(\n title = \"title\",\n location = \"location\",\n date = \"year\",\n description = \"detail\"\n)",
"text": "You can find a simple example and qmd code.\n\n\nYou can use the template with quarto command.\nquarto use template kazuyanagimoto/quarto-awesomecv-typst\n\n\n\nSet author information in YAML.\nauthor:\n firstname: Albert\n lastname: Einstein\n address: \"Rämistrasse 101, CH-8092 Zürich, Switzerland, Zürich\"\n positions: [\"Research Physicist\", \"Professor\"]\n contacts:\n - icon: fa envelope\n text: ae@example.com\n url: \"mailto:ae@example.com\"\n - icon: PATH_TO_ICON/icon.svg\n text: example.com\n url: https://example.com\n\nfontawesome icons are supported via duskmoon314/typst-fontawesome with fa prefix.\nSVG icons can be used by specifying the path to the icon file\n\n\n\n\nYou can set fonts and the accent color in YAML.\nstyle:\n color-accent: \"516db0\"\n font-header: \"Roboto\"\n font-text: \"Source Sans Pro\"\nformat:\n awesomecv-typst:\n font-paths: [\"PATH_TO_FONT\"]\n\n\n\nresume_entry() is a helper function to create resume entryies from a data frame.\ndf_educ |&gt;\n resume_entry(\n title = \"title\",\n location = \"location\",\n date = \"year\",\n description = \"detail\"\n)",
"crumbs": [
"Home"
]
Expand Down
Loading

0 comments on commit a018080

Please sign in to comment.