elm-pages-v3-beta/CHANGELOG-ELM.md
2020-02-03 12:18:30 -08:00

4.3 KiB

Changelog Elm package

All notable changes to the dillonkearns/elm-pages elm package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[3.0.2] - 2020-02-03

Fixed

  • Fixed an issue where "Missing content" message flashed for the root page.
  • Scroll up to the top of the page on page navigations (Elm's core Browser.application doesn't do this automatically). This change preserves the behavior for navigating to anchor links, so you can still go to a fragment and it will take you to the appropriate part of the page without scrolling to the top in those cases.

[3.0.1] - 2020-01-30

Changed

[3.0.0] - 2020-01-25

Changed

  • Added URL query and fragment in addition to the PagePath provided by init and onPageChange. See #39. The new data structure used looks like this:
    { path : PagePath Pages.PathKey
    , query : Maybe String
    , fragment : Maybe String
    }

[2.0.0] - 2020-01-25

Added

  • There's a new generateFiles endpoint. You pass in a function that takes a page's path, page metadata, and page body, and that returns a list representing the files to generate. You can see a working example for elm-pages.com, here's the entry point, and here's where it generates the RSS feed. You can pass in a no-op function like \pages -> [] to not generate any files.

[1.1.3] - 2020-01-23

Fixed

  • Fix missing content flash (that was partially fixed with #48) for some cases where paths weren't normalized correctly.

[1.1.2] - 2020-01-20

Fixed

  • "Missing content" message no longer flashes between pre-rendered HTML and the Elm app hydrating and taking over the page. See #48.

[1.1.1] - 2020-01-04

Fixed

  • Don't reload pages when clicking a link to the exact same URL as current URL. Fixes #29.

[1.1.0] - 2020-01-03

Check out this upgrade checklist for more details and steps for upgrading your project.

Added

  • There's a new StaticHttp API. Read more about it in this StaticHttp announcement blog post!
  • The generated Pages.elm module now includes builtAt : Time.Posix. Make sure you have elm/time as a dependency in your project! You can use this when you make API requests to filter based on a date range starting with the current date. If you want a random seed that changes on each build (or every week, or every month, etc.), then you can use this time stamp (and perform modulo arithemtic based on the date for each week, month, etc.) and use that number as a random seed.

Changed

  • Instead of initializing an application using Pages.application from the generated Pages module, you now initialize the app using Pages.Platform.application which is part of the published Elm package. So now it's easier to browse the docs. You pass in some internal data from the generated Pages.elm module now by including this in the application config record: Pages.Platform.application { internals = Pages.internals, ... <other fields> }.
  • Add init argument and user Msg for initial PagePath and page changes (see #4).

[1.0.1] - 2019-11-04

Fixed

  • Generate files for extensions other than .md and .emu (fixes #16). As always, be sure to also use the latest NPM package.