diff --git a/.changelog b/.changelog index 61c2000..11e905f 100644 --- a/.changelog +++ b/.changelog @@ -7,6 +7,7 @@ return [ 'description' => 'Other miscellaneous changes', ], ], + 'path' => 'docs/pages/changelog.md', 'releaseCommitMessageFormat' => 'release: new version {{currentTag}}', 'tagPrefix' => '', 'packageBump' => false, diff --git a/README.md b/README.md index f349978..df189b3 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ Valinor • PHP object mapper with strong type support [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FCuyZ%2FValinor%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/CuyZ/Valinor/master) + + Valinor is a PHP library that helps to map any input into a strongly-typed value object structure. @@ -21,7 +23,7 @@ composer require cuyz/valinor ## Documentation -Documentation can be found at [valinor.cuyz.io](valinor.cuyz.io). +Documentation can be found at [valinor.cuyz.io](https://valinor.cuyz.io). ## Credits & thank you diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 17370cc..ec5a2a1 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -17,9 +17,9 @@ extra: theme: name: material - icon: - repo: fontawesome/brands/github - logo: material/pine-tree + custom_dir: overrides + favicon: img/valinor-icon.svg + logo: img/valinor-icon.svg features: - navigation.sections - navigation.top @@ -28,15 +28,15 @@ theme: palette: - media: "(prefers-color-scheme: light)" scheme: default - primary: deep purple - accent: deep purple + primary: blue grey + accent: blue grey toggle: icon: material/brightness-7 name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: deep purple - accent: deep purple + primary: blue grey + accent: blue grey toggle: icon: material/brightness-4 name: Switch to light mode @@ -61,6 +61,7 @@ nav: - Introduction: index.md - Getting Started: getting-started.md - Credits: credits.md + - Changelog: changelog.md - Usage: - Validation: validation.md - Message customization: message-customization.md diff --git a/docs/overrides/partials/toc-item.html b/docs/overrides/partials/toc-item.html new file mode 100644 index 0000000..c93b250 --- /dev/null +++ b/docs/overrides/partials/toc-item.html @@ -0,0 +1,19 @@ + +
  • + + {{ toc_item.title }} + + + + {% if toc_item.children %} + + {% endif %} +
    • diff --git a/CHANGELOG.md b/docs/pages/changelog.md similarity index 97% rename from CHANGELOG.md rename to docs/pages/changelog.md index ee5bc19..ce21035 100644 --- a/CHANGELOG.md +++ b/docs/pages/changelog.md @@ -1,9 +1,28 @@ +--- +toc_depth: 2 +--- + # Changelog All notable changes to this project will be documented in this file. +## [0.10.0](https://github.com/romm/Valinor/compare/0.9.0...0.10.0) (2022-06-10) + +### Notable changes + +Documentation is now available at [valinor.cuyz.io](https://valinor.cuyz.io). + +### Features + +* Support mapping to dates with no time ([e0a529](https://github.com/romm/Valinor/commit/e0a529a7e546c2e3ffb929f819256b90a5f7859a)) + +### Bug Fixes + +* Allow declaring promoted parameter type with `@var` annotation ([d8eb4d](https://github.com/romm/Valinor/commit/d8eb4d830bd0817a5de2d61c8cfa81e7e025064a)) +* Allow mapping iterable to shaped array ([628baf](https://github.com/romm/Valinor/commit/628baf1294aaf3ce65bc5af969073604e2005af8)) + ## [0.9.0](https://github.com/CuyZ/Valinor/compare/0.8.0...0.9.0) (2022-05-23) ### Notable changes diff --git a/docs/pages/img/valinor-icon.svg b/docs/pages/img/valinor-icon.svg new file mode 100644 index 0000000..4711bc7 --- /dev/null +++ b/docs/pages/img/valinor-icon.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/docs/pages/img/valinor-logo.svg b/docs/pages/img/valinor-logo.svg new file mode 100644 index 0000000..8570632 --- /dev/null +++ b/docs/pages/img/valinor-logo.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/docs/pages/index.md b/docs/pages/index.md index 19a662d..a288822 100644 --- a/docs/pages/index.md +++ b/docs/pages/index.md @@ -12,6 +12,8 @@ Valinor • PHP object mapper with strong type support [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FCuyZ%2FValinor%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/CuyZ/Valinor/master) + + Valinor is a PHP library that helps to map any input into a strongly-typed value object structure.