Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cammellos/typst-blue-header-cv
https://github.com/cammellos/typst-blue-header-cv
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cammellos/typst-blue-header-cv
- Owner: cammellos
- License: mit
- Created: 2024-10-31T14:20:01.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T09:40:42.000Z (3 months ago)
- Last Synced: 2024-12-29T03:46:55.829Z (21 days ago)
- Language: Typst
- Size: 2.99 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-typst - typst-blue-header-cv - Customizable Typst two-columns CV template with a top header. (Templates & Libraries / CV)
README
# Typst Blue Header CV
A sleek and professional CV template built with [Typst](https://typst.app/), featuring a stylish blue header for a standout look.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgements](#acknowledgements)
## Installation
To get started, ensure you have Typst installed. If Typst isn't installed yet, you can download it from [typst.app](https://typst.app/).
1. Clone this repository:
```
git clone https://github.com/cammellos/typst-blue-header-cv.git
```
2. Navigate into the project directory:
```
cd typst-blue-header-cv
```
There's a `flake.nix` file that you can use, `direnv` should automatically pick it up.
## Usage
Once you have Typst installed and the project cloned:
1. Open `assets/resume.yaml`
2. Customize the file with your own details.
3. Generate your CV:
```
make
```
4. Your PDF will be generated in `assets/resume.pdf`
### Makefile Instructions
This project includes a Makefile to facilitate building, watching for changes, and formatting Typst files. Here are the available commands:
### Commands
- **build**: Compile the Typst file into a PDF using the specified input YAML file and output path.
```
make build
```
- **watch**: Automatically rebuild the PDF whenever a `.typ` or `.yaml` file changes.
```
make watch
```
- **png**: Generate a PNG image from the compiled PDF.
```
make png
```
- **format**: Format the Typst files using Typstyle.
```
make format
```
### Variables
- **INPUT_FILE**: Specify the input YAML file for the resume (default: `./assets/resume.yaml`).
- **OUTPUT_FILE**: Specify the output PDF file (default: `./assets/resume.pdf`).
- **OUTPUT_IMAGE**: Specify the output PNG file (default: `./assets/resume.png`).
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a feature branch (git checkout -b feature-name).
3. Commit your changes (git commit -m 'Add feature name').
4. Push to the branch (git push origin feature-name).
5. Open a Pull Request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
This project is built upon the foundation provided by [Harkunwar/attractive-typst-resume](https://github.com/Harkunwar/attractive-typst-resume). Thank you for the inspiration and resources!