v0.39.0

Compare Source

• Enhancements
  • Allow custom search engines to be configured with support for https://hexdocs.pm
  • Improve admonition blocks so they better integrate with the page flow
  • Bug fixes
    • Add .cheatmd to EPUB to avoid broken links
  • Backwards incompatible changes
    • Validate :extras fields: if you were previously setting them to unexpected values, you may now get an exception
    • Setting exdoc:full-text-search-url metadata is no longer supported, using the new search engines configuration

v0.38.4

Compare Source

• Bug fixes
  • Fix escaping of links when they have ampersand in them
  • Increase spacing of footers in pages
  • Align stale icon positioning

v0.38.3

Compare Source

• Enhancements
  • Allow configuring autocomplete limit, and default it to 10 instead of 8
  • Display description text in docs groups
  • Load discovered makeup apps for CLI

v0.38.2

Compare Source

• Bug fixes
  • Render documents with hardcoded <h2>/<h3> entries correctly
  • Fix padding on external links

v0.38.1

Compare Source

• Bug fixes
  • Ensure stripping apps for Erlang sources emit valid AST

v0.38.0

Compare Source

• Enhancements

  • Allow listing outside URLs in extras

  • Bug fixes

    • Ensure some cases where <, >, & and in headers would appear as entities in the sidebar
    • Fix outline caused by swup.js on Webkit based browsers
    • Fix bugs when computing synopsis
    • Automatically close the sidebar when navigating sections on mobile

v0.37.3

Compare Source

• Bug fixes
  • Handle http-equiv=refresh during Swup.js navigation
  • Include full error description when syntax highlighting fails

v0.37.2

Compare Source

• Bug fixes
  • Fix code highlighting for languages with non-alphanumeric characters

v0.37.1

Compare Source

• Enhancements

  • Support umbrella projects via the CLI

  • Bug fixes

    • Make sure docs are rendered inside iframes

v0.37.0

Compare Source

Thanks to @​liamcmitchell and @​hichemfantar for the extensive contributions in this new release.

• Enhancements

  • Optimize and parallelize module retriever, often leading to 20x-30x faster docs generation
  • Considerably improve page loading times in the browser
  • Allow customizing search_data for extra pages
  • Use native style for scroll bars
  • Enhance links between extras/pages/guides with padding and hover effects
  • Go to latest goes to the same page if it exists, root otherwise
  • Apply new style and layout for tabs
  • Increase font-weight on sidebar on Apple machines/devices
  • Improve accessibility across deprecation, links, and summaries
  • Add compatibility to Erlang/OTP 28+
  • Rely on the operating system monospace font for unified experience and better load times
  • Introduce "exdoc:loaded" window event to track navigation
  • Support for favicons

• Bug fixes

  • Move action links out from heading tags

v0.36.1

Compare Source

• Enhancements

  • Show a progress bar if navigation takes more than 300ms

  • Bug fixes

    • Fix dark mode styling on cheatsheets
    • Ensure the sidebar closes on hosting navigation in mobile

v0.36.0

Compare Source

• Enhancements

  • Use swup.js for navigation on hosted sites

  • Support :group in documentation metadata for grouping in the sidebar

  • Support :default_group_for_doc in configuration to set the default group for functions, callbacks, and types

  • Add --warnings-as-errors flag to mix docs

  • Bug fixes

    • Fix typespec with (...) -> any()
    • Do not trap tab commands in the search bar

v0.35.1

Compare Source

• Bug fixes
  • Make sure symlinks are copied from assets directory
  • Discard private functions documented by EDoc

v0.35.0

Compare Source

• Enhancements

  • Store proglang in searchdata.js

  • Allow searching for atoms inside backticks

  • Add support for nominal types from Erlang/OTP 28

  • Support a new :redirects option which allows configuring redirects in the sidebar

  • Improve warning when referencing type from a private module

  • Rename "Search HexDocs package" modal to "Go to package docs"

  • Support built-in Erlang/OTP apps in "Go to package docs"

  • Bug fixes

    • Switch anchor title to aria-label
    • Convert admonition blockquotes to sections for screen reader users
    • Fix code copy buttons within tabsets

v0.34.2

Compare Source

• Enhancements

  • Allow anchors on function and callback autolinks

  • Bug fixes

    • Make module attributes searchable without leading @​
    • Make Mod.fun pairs searchable without the arity
    • Do not emit warnings on unary plus in typespecs
    • Add top margin to nested module prefix in sidebar

v0.34.1

Compare Source

• Enhancements

  • Add a v shortcut to open/focus the version select

  • Compatibility fixes for Elixir v1.17 and Erlang/OTP 27+

  • Bug fixes

    • Do not crash on unknown media types in assets during EPUB generation
    • Fix slight shift on search bar input during focus
    • Avoid unwanted showing/hiding of search bar on mobile when scrolling

v0.34.0

Compare Source

This release requires Elixir v1.13.

• Enhancements

  • Allow several assets to be copied by passing a map to :assets
  • Improve compatibility when hosting ExDoc on a platform that strips .html

• Bug fixes

  • Link to the latest version of Erlang/OTP docs

• Deprecations

  • Deprecate passing a binary to :assets

v0.33.0

Compare Source

• Enhancements
  • Keep the sidebar light in light mode

v0.32.2

Compare Source

• Enhancements

  • Allow the modal to close when we click outside the modal content

  • Bug fixes

    • Fix indentation of -spec/-type in Erlang
    • Fix Mix task autolink for tasks with underscores
    • Avoid conflicts between custom headers with tooltips/modals

v0.32.1

Compare Source

• Bug fixes
  • Add version dropdown back on hexdocs.pm
  • Improve search input styling and scrolling

v0.32.0

Compare Source

• Enhancements

  • Add the ability to see previews during autocompletion

  • Remove serif font for content and prefer using the operating system font instead

  • Allow the search bar to be focused at any moment

  • Make functions acceptable for :skip_undefined_reference_warnings_on

  • Make functions acceptable for :skip_code_autolink_to

  • Allow using meta tags to disable autocompletion and configure the full text search

  • Bug fixes

    • Fix blockquote padding inside tabset on small screens
    • Consistently index h2 and h3 headers

v0.31.2

Compare Source

• Enhancements

  • Add equiv handling for types and callbacks for Erlang

  • Add cmd-k/ctrl-k shortcut to focus searchbar

  • Use dark backgrounds for admonition blocks in dark theme

  • Autolink .cheatmd files

  • Warn when extra link targets an application not in dependencies

  • Add support for before_closing_footer_tag

  • Bug fixes

    • Fix sidebar toggle flickering on page load
    • Fix background color inside code snippets with no language in dark mode
    • Hide search bar and background layer on print
    • Use blue links for Erlang
    • Fix logo not declared in EPUB's OPF manifest
    • Escape URIs and titles in EPUB
    • Fix URL slug not updating on anchor clicks

v0.31.1

Compare Source

• Enhancements
  • Make the sidebar horizontally resizable
  • Show the sidebar button and search bar on scroll up on mobile devices
  • More improvements to Erlang/OTP 27 support
  • Document that source_url_pattern can be a fun
  • Support m:Module#anchor

v0.31.0

Compare Source

• Enhancements

  • Allow searching atoms, module attributes, and words finishing with ? and !

  • Support upcoming Erlang/OTP 27 documentation format

  • Include prebuilt binaries on every release

  • Add borders dividing table rows in rendered content

  • Add accurate warnings for missing docs from Elixir v1.16+

  • Support e:dep:some-page.md for explicitly linking to a page in a package

  • Support m:SomeModule for explicitly linking to a module

  • Add noindex meta tag to 404 and Search pages

  • Move search to the main content so we can display more results

  • Warn when referencing functions, types, and callbacks from filtered out modules

  • Bug fixes

    • Fix search for words with hyphens in them
    • Fix search for contents inside EEx interpolation

v0.30.9

Compare Source

• Bug fixes

  • Fix a scenario where invalid assets would be generated

  • Enhancements

    • Add admonition EPUB styles

v0.30.8

Compare Source

• Bug fixes
  • Fix regression in umbrella applications

v0.30.7

Compare Source

• Bug fixes

  • Do not crash on EDoc type annotations

  • Do not crash on functions without name

  • Handle remote types in records

  • Fix scrolling to top on iOS

  • Fix invalid output markup for “hover link” headings

  • Enhancements

    • Support any String.Chars as the extra page name
    • Improve screen reader accessibility
    • Add :skip_code_autolink_to option

v0.30.6

Compare Source

• Enhancements
  • Extract title from Markdown file when preceded with comments
  • Improve focus navigation in notebooks

v0.30.5

Compare Source

• Bug fixes
  • Fix style for code in headers
  • Fix search data generation for Erlang/OTP

v0.30.4

Compare Source

• Bug fixes
  • Fix style for anchors in headers

v0.30.3

Compare Source

• Enhancements

  • Compress search index before storing in local storage

  • Bug fixes

    • Fix styling for headers on cheatsheets and small screens

v0.30.2

Compare Source

• Bug fixes
  • Fix escaping in search_data.json
  • Skip vega-lite code blocks in search_data.json

v0.30.1

Compare Source

• Bug fixes
  • Fix styling for headers on cheatsheets and small screens