Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zeyu2001 committed Nov 23, 2024
1 parent 1c9087e commit 52895cf
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Then install the git hooks:
pre-commit install
```

The hook configuration is stored in `.pre-commit-config.yaml`. The specific hook being run is `latexindent`, and its behaviour can be configured in `.latexindent.yaml`.
The hook configuration is stored in [`.pre-commit-config.yaml`](.pre-commit-config.yaml). The specific hook being run is `latexindent`, and its behaviour can be configured in [`.latexindent.yaml`](.latexindent.yaml).

## VS Code Extension

It is also convenient to use the [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) extension for VS Code to build and preview the LaTeX files. Configure the `latexindent` command line arguments in the extension settings to match the configuration in `.pre-commit-config.yaml`.

## CI/CD

This repository uses GitHub Actions to build the LaTeX files and deploy the HTML version to GitHub Pages. The workflow configuration is stored in `.github/workflows/main.yml`.
This repository uses GitHub Actions to deploy the HTML version to GitHub Pages. The workflow configuration is stored in [`.github/workflows/deploy-to-pages.yml`](.github/workflows/deploy-to-pages.yml). It uses [https://github.com/pdf2htmlEX/pdf2htmlEX](https://github.com/pdf2htmlEX/pdf2htmlEX) to convert the PDF to HTML.

## License

Expand Down
Binary file modified cv.pdf
Binary file not shown.

0 comments on commit 52895cf

Please sign in to comment.