diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..921fd23 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,33 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). + +## [1.0] - 2024-??-?? + +### 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`. + + + +[unreleased]: https://github.com/sinaatalay/rendercv/compare/v1.0...HEAD +[1.0]: https://github.com/sinaatalay/rendercv/releases/tag/v1.0 diff --git a/mkdocs.yaml b/mkdocs.yaml index fa10bd9..27a8033 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -52,6 +52,7 @@ nav: - data_models.py: reference/data_models.md - renderer.py: reference/renderer.md - themes: reference/themes.md + - Changelog: changelog.md markdown_extensions: # see https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ for more pymdownx info