Skip to content

Commit

Permalink
docs: add vitepress docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
jankapunkt committed Feb 6, 2025
1 parent 2ff4e52 commit f60acd2
Show file tree
Hide file tree
Showing 9 changed files with 2,678 additions and 0 deletions.
66 changes: 66 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
# with:
# version: 9 # Not needed if you've set "packageManager" in package.json
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci # or pnpm install / yarn install / bun install
- name: Build with VitePress
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
49 changes: 49 additions & 0 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "latexcv.pro",
description: "Free LaTeX cv and resume templates",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: '/media/logo.svg',
nav: [
{ text: 'Home', link: '/' },
{
text: 'Getting started',
items: [
{ text: 'Edit on Overleaf', link: 'https://www.overleaf.com/latex/templates?q=jan+k%C3%BCster' },
{ text: 'Build via Docker', link: 'https://github.com/jankapunkt/latexcv?tab=readme-ov-file#using-docker' },
{ text: 'Build manually', link: 'https://github.com/jankapunkt/latexcv/?tab=readme-ov-file#manual-build' }
]
},
{
text: 'Donate',
items: [
{ text: 'Sponsor on GitHub', link: 'https://github.com/sponsors/jankpunkt' },
{ text: 'Via PayPal', link: 'https://paypal.me/kuesterjan' }
]
}
],

sidebar: [
{
text: 'Getting started',
items: [
{ text: 'Edit on Overleaf', link: 'https://www.overleaf.com/latex/templates?q=jan+k%C3%BCster' },
{ text: 'Build via Docker', link: 'https://github.com/jankapunkt/latexcv?tab=readme-ov-file#using-docker' },
{ text: 'Build manually', link: 'https://github.com/jankapunkt/latexcv/?tab=readme-ov-file#manual-build' }
]
}
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/jankapunkt/latexcv' }
],

footer: {
message: 'All templates are released under the MIT License.',
copyright: 'Copyright © 2025-present Jan Küster'
}
}
})
49 changes: 49 additions & 0 deletions docs/api-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
outline: deep
---

# Runtime API Examples

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:

```md
<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```

<script setup>
import { useData } from 'vitepress'

const { site, theme, page, frontmatter } = useData()
</script>

## Results

### Theme Data
<pre>{{ theme }}</pre>

### Page Data
<pre>{{ page }}</pre>

### Page Frontmatter
<pre>{{ frontmatter }}</pre>

## More

Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).
200 changes: 200 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "latexcv.pro"
text: "Free LaTeX cv and resume templates"
tagline: Crafting your own is essential to stand out. These templates will make it easy as a snap! Select one and just get started. They're all free, no hidden costs!
image:
src: /media/logo.svg
alt: LaTeX CV Banner
actions:
- theme: brand
text: Edit on Overleaf
link: https://www.overleaf.com/latex/templates?q=jan+k%C3%BCster
- theme: alt
text: Build via Docker
link: https://github.com/jankapunkt/latexcv?tab=readme-ov-file#using-docker
- theme: alt
text: Build manually
link: https://github.com/jankapunkt/latexcv/?tab=readme-ov-file#manual-build

---


<script setup>
import { VPTeamMembers } from 'vitepress/theme'

const members = [
{
avatar: 'https://avatars.githubusercontent.com/u/1135285?v=4',
name: 'Jan Küster',
title: 'Creator of LaTeX cv',
sponsor: 'https://github.com/sponsors/jankapunkt',
links: [
{ icon: 'github', link: 'https://github.com/jankapunkt' },
{ icon: 'linkedin', link: 'https://www.linkedin.com/in/jan-kuester/' }
]
},
]
</script>


## Gallery

<div align="center">
<table width="100%" margin-left="auto" margin-right="auto">
<tr>
<th>Classic</th>
<th>Modern</th>
<th>Minimalistic</th>
</tr>
<tr>
<td width="33%">
<img src="/media/classic.png"
alt="Classic CV example preview" />
<a href="https://www.overleaf.com/latex/templates/jan-kusters-classic-cv/tvghvdsffwgs">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/modern.png"
alt="Modern CV example preview" />
<a href="https://www.overleaf.com/latex/templates/jan-kusters-modern-cv/kbfxhgjtxhgh">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/minimal.png"
alt="Minimalistic Layout CV example preview" />
<Badge type="tip" text="Soon on Overleaf!" />
</td>
</tr>
</table>

<table width="100%" margin-left="auto" margin-right="auto">
<tr>
<th>Two Columns</th>
<th>Sidebar</th>
<th>Sidebar Left</th>
</tr>
<tr>
<td width="33%">
<img src="/media/two_column.png"
alt="Two Column CV example preview" />
<a href="https://www.overleaf.com/latex/templates/jan-kusters-two-column-cv/mgdkqgdcktjv">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/sidebar.png"
alt="Sidebar CV example preview" />
<a href="https://www.overleaf.com/latex/templates/sidebar-cv/kssfdykmmdvz">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/sidebarleft.png"
alt="Left sidebar CV example preview" />
<a href="https://www.overleaf.com/latex/templates/jan-kusters-left-sidebar-cv/tmmnhrkcmpgv">Edit on overleaf</a>
</td>
</tr>
</table>

<table width="100%" margin-left="auto" margin-right="auto">
<tr>
<th>Row Layout</th>
<th>Infographics</th>
<th>Infographics 2</th>
</tr>
<tr>
<td width="33%">
<img src="/media/rows.png"
alt="Row-Layout CV example preview" />
<a href="https://www.overleaf.com/latex/templates/jan-kusters-row-layout-cv/pdjxrdkpddzq">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/infographics.png"
alt="Infographics CV example preview" />
<a href="https://www.overleaf.com/latex/templates/infographics-cv/hdgkztmhztph">Edit on overleaf</a>
</td>
<td width="33%">
<img src="/media/infographics2_en.png"
alt="Infographics CV example preview" />
</td>
</tr>
</table>
</div>

## Documentation and Source

All templates are hosted on GitHub. There, you'll also find the documentation and [the installation guides](https://github.com/jankapunkt/latexcv?tab=readme-ov-file#how-to-build), in case you want to edit them locally.


## FAQ


Please note: There is also [wiki section](https://github.com/jankapunkt/latexcv/wiki) with troubleshooting information or language-specific guides.´

<details>

<summary>Are there any hidden costs?</summary>

No! All templates are released under [MIT license](https://opensource.org/license/mit) and are free to use **AND** also free to (re-)distribute, even commercially!

</details>

<details>
<summary>How can I support you?</summary>

My templates helped you to lang a new job? Congratualtions, this is awesome!

You can either [sponsor me on GitHub](https://github.com/sponsors/jankapunkt) or [donate via PayPal](https://paypal.me/kuesterjan).

</details>

<details>
<summary>Why don't you provide classes?</summary>

I want these templates to be as beginner friendly as possible!
Many parts of the CV have to handcrafted to be pixel perfect, because everone
provides different content which complicates things a lot when using classes.

Instead, I opted for single standalone documents for each template, so you
can immediately start to add your content and change details on your own behalf
without changing the entire layout.

</details>



<details>
<summary>Can I help to improve the templates or documentation?</summary>

Of course! Please get familar with the [conribution guide](https://github.com/jankapunkt/latexcv/blob/master/CONTRIBUTING.md) and then we can get started!

</details>



<details>
<summary>I found a bug or technical problem and I'm sure it's a problem with one of your templates.</summary>

That's awesome, please [open an issue in the repository](https://github.com/jankapunkt/latexcv/issues) or get involved with me directly (info [at] jankuester [dot] com).

</details>

<details>
<summary>I have trouble setting up things or need help to make my CV look in a specific way.</summary>

First, I encourage you to seek help by [asking a question / opening a discussion](https://github.com/jankapunkt/latexcv/discussions) in the repository. Chances are, someone else already solved this issue.

If you want to reach out to me instead, please be aware of the following: While I'm always open to help, I'm doing this in my free time and mostly for free. Please understand, I will charge fees for personal support. Get in contact with me, if you're okay with it (info [at] jankuester [dot] com).

</details>



<details>
<summary>Can you design me a custom CV?</summary>

Yes, of course! However, please note that I'll charge you for the invested time and effort. However, you can get a decent discount, if you're willing to contribute the result as template (under MIT license) to this repository. Reach out to me via (info [at] jankuester [dot] com).

</details>

## Get in touch

<VPTeamMembers size="small" :members="members" />
Binary file added docs/media/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/banner_square.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f60acd2

Please sign in to comment.