rendercv/docs/changelog.md

69 lines
2.7 KiB
Markdown
Raw Normal View History

---
toc_depth: 1
---
2024-02-19 17:55:03 +00:00
# Changelog
All notable changes to this project will be documented in this file.
2024-02-19 17:55:03 +00:00
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
2024-03-09 18:46:14 +00:00
[Click here to see the unreleased changes.](https://github.com/sinaatalay/rendercv/compare/v1.3...HEAD)
2024-03-09 18:31:42 +00:00
<!--
### Fixed
### Changed
### Removed
2024-03-09 18:31:42 +00:00
### Added
-->
## [1.3] - 2024-03-09
### Fixed
2024-03-09 18:35:03 +00:00
- The `journal` is now displayed in the `PublicationEntry` of the `sb2nov` theme.
2024-03-09 18:31:42 +00:00
### Changed
- Future dates are now allowed.
- Authors' first names are no longer abbreviated in `PublicationEntry`.
- Markdown is now supported in the `authors` field of `PublicationEntry`.
- `doi` field is now optional for `PublicationEntry`.
### Added
- CLI documentation has been added to the user guide.
## [1.2] - 2024-02-27
### Fixed
- Fixed Markdown `TextEntry`, where all the paragraphs were concatenated into a single paragraph.
- Fixed Markdown `OneLineEntry`, where all the one-line entries were concatenated into a single line.
- Fixed the `classic` theme's `PublicationEntry`, where blank parentheses were rendered when the `journal` field was not provided.
2024-02-27 19:03:22 +00:00
- Fixed a bug where an email with special characters caused a LaTeX error.
- Fixed Unicode error when `rendercv new` is called with a name with special characters.
2024-02-25 22:47:00 +00:00
## [1.1] - 2024-02-25
2024-02-19 17:55:03 +00:00
### Added
- RenderCV is now a $\LaTeX$ CV framework. Users can move their $\LaTeX$ CV themes to RenderCV to produce their CV from RenderCV's YAML input.
- RenderCV now generates Markdown and HTML versions of the CV to allow users to paste the content of the CV to another software (like [Grammarly](https://www.grammarly.com/)) for spell checking.
- A new theme has been added: `moderncv`.
- A new theme has been added: `sb2nov`.
### Changed
- The data model is changed to be more flexible. All the sections are now under the `sections` field. All the keys are arbitrary and rendered as section titles. The entry types can be any of the six built-in entry types, and they will be detected by RenderCV for each section.
- The templating system has been changed completely.
- The command-line interface (CLI) is improved.
- The validation error messages are improved.
- TinyTeX has been moved to [another repository](https://github.com/sinaatalay/tinytex-release), and it is being pulled as a Git submodule. It is still pushed to PyPI, but it's not a part of the repository anymore.
- Tests are improved, and it uses `pytest` instead of `unittest`.
- The documentation has been rewritten.
- The reference has been rewritten.
- The build system has been changed from `setuptools` to `hatchling`.
2024-03-09 18:31:42 +00:00
[1.3]: https://github.com/sinaatalay/rendercv/releases/tag/v1.3
[1.2]: https://github.com/sinaatalay/rendercv/releases/tag/v1.2
2024-02-25 22:47:00 +00:00
[1.1]: https://github.com/sinaatalay/rendercv/releases/tag/v1.1