CHANGELOG.md (27591B)
1 # Changelog 2 3 ## v0.29.0 (2022-10-19) 4 5 * Enhancements 6 * Support cheatsheets as `.cheatmd` files 7 8 * Bug fix 9 * Collapse sidebar when resizing page even if stored in the session as opened 10 11 ## v0.28.6 (2022-10-13) 12 13 * Enhancements 14 * Add Elixir special punctuation ! and ? to natural sort 15 * Add night mode to settings pane 16 * Support --proglang in mix docs 17 * Save sidebar state per session 18 * Distinguish output code blocks in Livebooks 19 20 * Bug fixes 21 * Prevent sidebar button scrolling out of view 22 * Prevent unreadable text when using inline code with admonition headers 23 24 ## v0.28.5 (2022-08-18) 25 26 * Enhancements 27 * Do not preserve spaces from spec declaration in signature rendering 28 * Index hyphens in search 29 * Index `@` in search 30 * Change minimal package search length to 2 31 32 * Bug fixes 33 * Remove extra `term()` argument at start of `@macrocallback` 34 35 ## v0.28.4 (2022-04-28) 36 37 * Enhancements 38 * Add a toast when changing theme via keyboard 39 * Automatically convert `.livemd` links to `.html` ones 40 * Show programming language in HTML footer 41 42 * Bug fixes 43 * Properly escape `%/2` special form 44 * Improve ranking of exact-matching modules in search 45 46 ## v0.28.3 (2022-03-23) 47 48 * Enhacements 49 * Include page titles in autocomplete suggestions 50 * Allow theme to be set to "System" version 51 * Remove "Specs" heading and render full typespecs 52 * Support for `source_url_pattern` in config being a function 53 54 * Bug fixes 55 * Adjustments for blockquotes and admonition blocks in dark mode 56 * Fix module sorting when a list of dirs is provided 57 * Consider casing of letters when sorting items in the menu, summary, function list, etc 58 59 ## v0.28.2 (2022-02-23) 60 61 * Bug fixes 62 * Fix links and code tags in admonition text blocks for dark mode 63 64 ## v0.28.1 (2022-02-20) 65 66 * Enhancements 67 * Add support for admonition text blocks 68 * Improve accessibility for light and dark themes 69 70 * Bug fixes 71 * Ensure that `mix docs --open` works on Windows 72 * Ensure search tokenizer also splits on underscore 73 * Fix false warnings about missing types when running ExDoc in escript mode 74 * Don't navigate when clicking the current page 75 76 ## v0.28.0 (2022-01-24) 77 78 ExDoc v0.28.0 requires Elixir v1.11+. 79 80 * Enhancements 81 * Use custom scrollbar in the sidebar 82 * Keep hamburger absolute to the opened sidebar 83 * Support `--open` flag on `mix docs` 84 * The copy button now only copies selectable content 85 86 * Bug fixes 87 * Make sure filename configuration in `:extras` is used across links 88 * Ensure all `extras` pages have a title generated 89 * Fix margin on 3rd level headers and beyond 90 * Ensure a task that defines callbacks is still listed as a task 91 92 ## v0.27.3 (2022-01-12) 93 94 * Bug fixes 95 * Make HexDocs search case insensitive 96 * Improve sidebar open/close animation 97 98 ## v0.27.2 (2022-01-11) 99 100 * Bug fixes 101 * Fix version dropdown when hosted on HexDocs 102 * Fix tooltips 103 * Fix JavaScript error when Hex package information is not available 104 105 ## v0.27.1 (2022-01-11) 106 107 * Bug fixes 108 * Several usability fixes on the new layout 109 * Keep page ordering 110 111 ## v0.27.0 (2022-01-11) 112 113 * Enhancements 114 * Introduce new sidebar design 115 * Add `--quiet` option to CLI 116 * Support multiple formatters in the CLI 117 * Show structs as `%Struct{}` instead of `__struct__` in the sidebar 118 * Point Erlang links to `www.erlang.org` instead of `erlang.org` 119 * Improvements to the night mode and styling 120 121 ## v0.26.0 (2021-11-21) 122 123 * Backwards incompatible changes 124 * `:filter_prefix` has been renamed to `:filter_modules` and supports anonymous functions 125 * `:source_ref` now defaults to `"main"` 126 * Dropped support for smartypants in Markdown 127 128 * Bug fixes 129 * Do not warn on links to sections 130 131 * Enhancements 132 * Add copy button to code snippets 133 * Add `translate="no"` to the relevant attributes to improve interoperability with automatic translation tools 134 * Support optional module annotations 135 * Introduce a settings modal to group most of configuration 136 * Allow customizing the Livebook expansion URL 137 * Provide documentation on how to render plugins such as Katex, VegaLite, and Mermaid 138 139 ## v0.25.5 (2021-10-20) 140 141 * Bug fixes 142 * Do not duplicate API Reference title 143 * Update assets for Livebook badge functionality 144 145 ## v0.25.4 (2021-10-20) 146 147 * Enhancements 148 * Add source link to pages in `:extras` 149 * Add "Run in Livebook" badge to `.livemd` pages in `:extras` 150 151 * Bug fixes 152 * Do not generate entries for private Erlang functions 153 * Do not trim `?` and `!` from Elixir tokens on search 154 155 * Incompatible changes 156 * Remove unused `:source_root` option 157 158 ## v0.25.3 (2021-09-21) 159 160 * Enhancements 161 * Track user preference for sidebar state 162 163 * Bug fixes 164 * Do not double escape page titles on the sidebar 165 * Do not fail when documenting cover compiled modules 166 * Don't crash upon doc chunks for unknown beam languages 167 168 ## v0.25.2 (2021-09-02) 169 170 * Enhancements 171 * Add support for Livebook's `.livemd` Markdown files 172 * Preload all applications starting with `makeup_` before doc generation 173 * Add Hex package config and display "Find on Hex" footer links 174 175 ## v0.25.1 (2021-08-02) 176 177 * Enhancements 178 * Supporting grouping of callbacks 179 * Use shell lexer for code blocks with no language and starting with `$ ` 180 181 * Bug fixes 182 * Fix generating type signatures with maps 183 * Skip Erlang modules that have empty docs 184 * Skip Erlang functions that have empty docs 185 * Fix accidentally showing shape of opaque types 186 187 ## v0.25.0 (2021-07-20) 188 189 * Enhancements 190 * Handle remote types when generating signatures, e.g. `@callback callback1(GenServer.options())` becomes `callback1(options)` 191 * Support Markdown processor options 192 * Add `--paths` command line argument to prepend directories to the code path when generating docs 193 * Make shell prompt, `$ `, not selectable for `shell`, `sh`, `bash` and `zsh` code blocks 194 195 * Bug fixes 196 * Fix custom links to undefined/hidden references 197 * Fix generating external links with `:deps` configuration 198 * Add ellipsis to more sections 199 200 * Backwards incompatible changes 201 * Remove function landing pages 202 203 ## v0.24.2 (2021-04-06) 204 205 * Enhancements 206 * Support stepped range syntax 207 208 * Bug fixes 209 * Add spaces on paragraph endings for search results 210 * Fix bug defining app name in config 211 * Fix rendering void elements (`<br>` etc) 212 213 ## v0.24.1 (2021-03-22) 214 215 * Bug fixes 216 * Fix generating function landing pages 217 218 ## v0.24.0 (2021-03-16) 219 220 * Enhancements 221 * Drop jQuery and refactor JavaScript codebase 222 * Remove highlight.js in favour of migration to Makeup 223 * Change autolink to return both path and hash for the current module 224 * Add next/previous at the end of extra pages 225 * Improve search input blur handling 226 * Update erlang.org/man URL 227 * Add function landing page 228 229 * Bug fixes 230 * Ignore extensions when generating external links 231 * Fix autolink to handle URIs with arbitrary scheme part without warning 232 * Fix undefined reference warning for typespecs 233 * Fix search click behavior when a suggestion refers the current page 234 * Don't crash when we can't format spec 235 * Fix HTML escaping 236 237 ## v0.23.0 (2020-10-12) 238 239 Requires Elixir v1.10. 240 241 * Enhancements 242 * Improve warnings on broken references 243 * Support Elixir v1.12-dev 244 245 * Bug fixes 246 * Respect deps config in autolink 247 * Fix html escaping in the sidebar entries 248 * Fix retrieving specs for macros with `when` 249 * Raise if none of :name or :app are found in mix.exs 250 * Don't crash on code blocks like "A.b.C" 251 252 ## v0.22.6 (2020-09-16) 253 254 * Bug fixes 255 * Properly fix CSS bug on headings 256 * Add expansion arrow to sections on sidebar 257 258 ## v0.22.5 (2020-09-13) 259 260 * Bug fixes 261 * Fix CSS bug on headings 262 263 ## v0.22.4 (2020-09-12) 264 265 * Enhancements 266 * Improve accessibility and add aria labels 267 * Show different title and message for a empty search value 268 269 ## v0.22.3 (2020-07-25) 270 271 * Bug fixes 272 * [HTML+EPUB] Remove overlapping functions from defaults 273 * [HTML] Don't show tooltip for module sections and non-html files 274 * [HTML] Make sure tooltips work with escape ids. 275 276 ## v0.22.2 (2020-07-20) 277 278 * Enhancements 279 * [HTML+EPUB] Add support for path dependent markdown autolink (`feeddc1`) 280 * [HTML+EPUB] Improve auto-linking to callbacks and types (`12c0a01`) 281 * [HTML+EPUB] Replace `<kbd>` with `<kbd><kbd>` when it represents keys to be hit (`bd2b8df`) 282 * [HTML] Hide sidebar-over-content on click/tap outside it (`b050775`) 283 * [HTML] Redirect to correct file when changing version (`0f6f24b`) 284 * [mix docs] Allow files with no extension in extra files (`26b93b6`) 285 * [mix docs] Link to siblings in an umbrella (`b0d6fdd`) 286 * [mix docs] Switch to `earmark_parser`. Run `mix deps.unlock --unused` to remove the now 287 unused `earmark` dependency. (`021c772`) 288 289 * Bug fixes 290 * [HTML+EPUB] Bring back auto-linking to Kernel and Kernel.SpecialForms (`fa174eb`) 291 * [HTML+EPUB] Escape HTML special characters in signature (`5fed479`) 292 * [HTML+EPUB] Fix auto-linking `./2` and `../2` (`2e40acb`) 293 * [HTML+EPUB] Fix list of basic types to auto-link (`6df4a3b`) 294 * [HTML+EPUB] Make HTML valid (`1187ace`) 295 * [HTML] Escape HTML special characters in sidebar (`d26ca71`) 296 * [HTML] Fix keyboard shortcuts on non US keyboard layouts (`829c4ee`) 297 * [HTML] Fix text overflow in sidebar (`a4ff547`) 298 * [HTML] Handle snake case terms in search results (`d511d55`) 299 * [mix docs] Don't crash on markdown that triggers warning (`e7cb79c`) 300 301 ## v0.22.1 (2020-05-19) 302 303 * Bug fixes 304 * [mix docs] Depend on earmark `~> 1.4.0` 305 * [mix docs] Don't crash on comments in markdown 306 * [mix docs] Don't crash on HTML in markdown 307 308 ## v0.22.0 (2020-05-11) 309 310 * Enhancements 311 * [EPUB] Add epub to the default formatters 312 * [HTML+EPUB] Move specs out of signature 313 * [HTML+EPUB] Auto-link "erlang" types & callbacks 314 * [HTML+EPUB] Auto-link "erlang" modules in custom links 315 * [mix docs] Warn on broken references in dependencies (e.g. `` `String.upcase/9` ``) 316 * [escript] Add `--app` 317 * [HTML+EPUB] Auto-link to extras (e.g. `[foo](foo.md)`) 318 * [mix docs] Undefined references warning now includes the filename 319 * [mix docs] `:skip_undefined_reference_warnings_on` now also accepts a filename 320 * [HTML+EPUB] Display moduledoc headings in the sidebar 321 322 * Bug fixes 323 * [HTML] Fix hidden text selection, hide tooltips for details link 324 * [HTML+EPUB] Fix function name sorting (group operators together) 325 * [HTML+EPUB] Fix displaying nested modules 326 327 * Backwards incompatible changes 328 * [mix docs] Remove built-in support for cmark markdown processor 329 * [mix docs] Replace `ExDoc.Markdown.to_html/2` with `to_ast/2` 330 * [HTML+EPUB] Remove auto-linking for local calls to Kernel & Kernel.SpecialForms, 331 use fully qualified calls instead. (e.g. replace `` `==/2` `` with `` `Kernel.==/2` ``.) 332 * [mix docs] `:skip_undefined_reference_warnings_on` no longer accepts extras id, use 333 extras filename instead. 334 335 ## v0.21.3 336 337 * Enhancements 338 * [HTML] Make "Exceptions" a module sub-grouping instead of a top-level group 339 * [HTML] Automatically group deprecated modules 340 * [HTML] Rely on `prefers-color-scheme` w/o night mode set 341 * [HTML] Boost title on search results, add fun/arity to title 342 * [mix docs] Initial work on support for multiple languages 343 344 * Bug fixes 345 * [HTML] Many improvements to the search engine 346 * [mix docs] Link to callback docs instead of copying them 347 348 ## v0.21.2 349 350 * Enhancements 351 * [HTML] Add hardcoded packages to the quick-switch search results 352 * [HTML] Filter out packages without docs on HexDocs in quick-switch 353 * [HTML+EPUB] Support autolinking for multiple arities 354 * [mix docs] Avoid deprecation warnings on more recent earmark versions 355 * [mix docs] Warn on unavailable local functions 356 * [mix docs] Make invalid index redirect warning case-sensitive 357 * [mix docs] Ignore non-Elixir modules when missing chunk 358 359 * Bug fixes 360 * [HTML+EPUB] Do not create a custom link when destination does not exist 361 * [EPUB] Hide screen reader elements 362 363 ## v0.21.1 364 365 * Bug fixes 366 * [HTML] Make sure package selector can be reopened after closed with `ESC` 367 * [HTML] Ensure tooltip pages can be cached 368 * [HTML] Support large version numbers on the version dropdown 369 * [mix docs] Raise nice exception for missing ExDoc.Config 370 371 ## v0.21.0 372 373 * Enhancements 374 * [HTML] Add support for reference popovers 375 * [HTML] Provide a "g" shortcut to Go To a Hexdocs package (with autocomplete) 376 * [HTML] Detect if browser prefers night mode 377 * [EPUB] Add support for covers and the authors field 378 379 * Bug fixes 380 * [HTML+EPUB] Ensure that link headers generate unique IDs 381 * [HTML+EPUB] Sort structs fields so field names are always ordered 382 * [HTML+EPUB] Do not strip "Elixir." prefix from module names 383 * [HTML] Support URLs with non-HTML safe characters 384 * [EPUB] Fix table of contents without groups 385 386 ## v0.20.2 387 388 * Enhancements 389 * Add "mix " prefix to Mix tasks 390 391 * Bug fixes 392 * Improve scrolling on Safari 393 * Prevent text casing of codes 394 * Do not remove stop words from search and make sure function names are searchable in isolation 395 * Reduce the size of the search metadata 396 * Remove outline on focus and keep width in version dropdown 397 * Do not fail if we can't persist index 398 399 ## v0.20.1 400 401 * Bug fixes 402 * Hide the spinner when no term is searched 403 * Use `?` for the shortcut hint text 404 * Improve style of the version dropdown 405 406 ## v0.20.0 407 408 * Enhancements 409 * Rework the search bar to provide autocompletion 410 * Provide full-text search 411 * Automatically generate documentation for `defdelegate` definitions (requires Elixir v1.8+) 412 * Provide keyboard shortcuts (press `?` to see all available outputs) or click the link at the bottom of the page 413 * Add support for versions dropdown to the HTML sidebar. This requires adding a `docs_config.js` (also configurable) that sets a `versionNodes` JavaScript variable. 414 * Improve mouseover titles on sidebar navigation 415 416 * Bug fixes 417 * Do not hide structs in type/callback summary signatures 418 * No longer require double click to open up a sidebar on Mobile Safari 419 * Keep trailing periods in summaries 420 * Fix typespec `arg` number to start from 1 instead of 0 421 422 ## v0.19.3 423 424 * Enhancements 425 * Include a "goto" link on mouseover for expandable menu items 426 427 * Bug fixes 428 * Always expand menu items, even if has a single child 429 * Fix sidebar bottom margin on Firefox 430 * Fix anchor links sometimes not working by moving JS to HTML head 431 * Unify code styling for makeup and hljs 432 * Do not replace the content of custom links pointing to Elixir modules 433 * Remove border-left on deprecated to not mistake it with a heading 434 435 ## v0.19.2 436 437 * Enhancements 438 * Allow logo in SVG extension 439 * Allow functions to be grouped based on metadata 440 * Allow api-reference.html page to be disabled 441 * Allow nesting of modules by prefix 442 * Autolink `mix help TASK` 443 * Warn on undefined remote functions from project's docs 444 445 * Bug fixes 446 * Sort function names alphabetically in the sidebar 447 * Fix search input color 448 * Disable earmark smartypants option 449 450 ## v0.19.1 451 452 * Enhancements 453 * Update CSS styles 454 * Remove sourcemaps from package 455 456 ## v0.19.0 457 458 This release requires Elixir v1.7 and later. For earlier Elixir versions, use ExDoc ~> 0.18.0. 459 460 * Enhancements 461 * Do not select "iex>" when selecting code samples 462 * Use makeup to perform ELixir's syntax highlighting (other languages still use highlight.js) 463 * Use `[rel="noopener"]` on external links 464 * Link directly to page if sidebar item has no subitems 465 * Autolink Kernel and Kernel functions and special forms with shorthands (for example, only `is_atom/1` is necessary) 466 * Trim EEx contents to reduce HTML size 467 * Allow apps to be excluded from umbrella app docs 468 469 * Bug fixes 470 * Exclude types with `@typedoc false` from the docs 471 * Make sure autolink considers the longest matching dependency name in case of shared prefixes 472 473 ## v0.18.3 474 475 * Bug fix 476 * Fix formatting of typespecs causing errors 477 * Update jQuery 478 * Properly remove underscore from typespec links 479 480 ## v0.18.2 481 482 * Enhancements 483 * Improve documentation pages for printing 484 * Autolink Kernel, Kernel.SpecialForms, and built-in types 485 * Annotate opaque types 486 * Add vertical-align:top to tables 487 * Allow module-function-arity references in links 488 * Remove underscore from view source link 489 * Run code formatter on typespecs (if one is available) 490 * Make night mode switch link more obvious 491 492 ## v0.18.1 493 494 * Bug fixes 495 * Include missing formatter files 496 497 ## v0.18.0 498 499 * Enhancements 500 * No longer strip empty parens from types 501 * Provide more extension point for markdown processors 502 * Remove assets from priv since they are now embedded at compile time 503 504 * Backwards incompatible changes 505 * Remove built-in support for hoedown markdown processor 506 * No longer add favicon when logo option is present (this was added in 0.17.0 but it was reported the logo almost never fits as a favicon) 507 508 ## v0.17.1 509 510 * Bug fixes 511 * Fix broken search caused by outdated JavaScript files 512 513 ## v0.17.0 514 515 * Enhancements 516 * Allow modules to be grouped on the sidebar with the `:groups_for_modules` option 517 * Allow extras to be grouped on the sidebar with the `:groups_for_extras` option 518 519 * Backwards incompatible changes 520 * The previous `:group` option that could be specified for each entry in `:extras` is no longer supported 521 * No longer add a specific section for "Protocols". If you would like to segregate the protocols in your application, use the new `:groups_for_modules` functionality 522 523 ## v0.16.4 524 525 * Enhancements 526 * Generate favicon link if a logo is available 527 528 * Bug fixes 529 * Do not version epub filename as the doc directory is likely already versioned 530 531 ## v0.16.3 532 533 * Enhancements 534 * Make sure its own search.html page and provide history 535 * Generate source maps only if the `--debug` flag is given 536 * Users can now add custom HTML before the closing head tag and the closing body tag 537 * Highlight the target function/macro/type/callback when clicked 538 539 * Bug fixes 540 * Remove extra `term()` argument at start of macro spec 541 * Add unencoded link target for functions with special chars to cope with different behaviour in browsers 542 543 ## v0.16.2 544 545 * Enhancements 546 * Link `<h3>` headers as well 547 * Add border to code tag 548 * Bug fixes 549 * Fix sidebar on mobile devices 550 551 ## v0.16.1 552 553 * Bug fixes 554 * Fix hover icons coloring 555 556 ## v0.16.0 557 558 * Enhancements 559 * Separate tasks into "Mix Tasks" in sidebar 560 * Add types to the search results 561 * Improve accessibility 562 563 * Bug fixes 564 * Strip nesting HTML tags in h2 headers 565 * Remove the old search results after every new search attempt 566 567 ## v0.15.1 568 569 * Bug fixes 570 * Improve project name wrapping on HTML 571 * Properly set link in types with parameter 572 * Fix ExDoc.CLI.main/2 to keep --source-ref on Elixir v1.4 573 * Do not fail if localStorage is not available 574 575 ## v0.15.0 576 577 * Enhancements 578 * Closing the search takes you to where you were in the previous page 579 * Handle `__struct__/0` by displaying the struct instead 580 * Warn when redirecting to a non-existent file 581 * List both functions and macros under "Functions" 582 * Automatically detect GitLab source URL patterns 583 584 * Bug fixes 585 * Break long specs into lines 586 * Fix the initial state of the sidebar hamburger 587 * Do not error when abstract code is missing 588 * Properly link to erlang lib dirs 589 590 * Backwards incompatible changes 591 * No longer support Pandoc 592 * Require Earmark 1.1 593 594 ## v0.14.5 595 596 * Enhancements 597 * Allow ExDoc to work as an escript 598 599 ## v0.14.4 600 601 * Enhancements 602 * Point to Elixir docs on hexdocs.pm 603 * Many improvements to layout and styling of EPUB formatter 604 * Support multiple formatters to be configured on `mix.exs` 605 * Also digest `sidebar_items.js` 606 * Force parentheses on type signature to remove ambiguity 607 * Generate top-level docs for an umbrella project 608 * Searching on mobile closes menu when the Enter key is hit 609 610 ## v0.14.3 611 612 * Enhancements 613 * Support the `:assets` option that automatically copies all entries in the given directory to `doc/assets` 614 * Remove numbering on Extras subheaders from sidebar 615 * Pass file and line information to markdown formatters for better warnings 616 * Allow extra pages to be grouped together under a given heading 617 * Generate ids for default name/arity pairs so they can be linked (both remotely and locally) 618 619 * Bug fixes 620 * Fix autolink for functions containing `%`, `{`, `}` or uppercase characters in the name 621 622 ## v0.14.2 623 624 * Enhancements 625 * Automatically generate documentations links to any of your dependencies (by default links to hexdocs.pm but allows the URL to be configured) 626 * Allow documentation to be generated to Erlang modules 627 628 * Bug fixes 629 * Make sure "Top" is not included twice on pages 630 631 ## v0.14.1 632 633 * Bug fixes 634 * Include "Top" link in pages with no headings 635 * Include "Top" link in modules with no docs 636 637 ## v0.14.0 638 639 * Enhancements 640 * Add support for the epub formatter 641 * Support extraction from `<h2>` headers out of the settext format 642 643 * Layout changes 644 * Indent documentation inside the function/macro/type/callback header 645 * Style types the same way as function/macro/callback and include a link to the source 646 * Increase font-sizes in the sidebar and code snippets 647 * Move the specs definition inside the function/macro/type/callback header and make better use of vertical space 648 * Use a gradient on the sidebar to avoid sudden cut-off when scrolling the modules list 649 * Fix the use of the back-button in some browsers 650 * Allow the whole sidebar to be navigated without moving away from the current page. Expand (+) and collapse (-) buttons have been added to aid exploration 651 * Numerically order pages/guides headers 652 653 ## v0.13.2 654 655 * Bug fixes 656 * Avoid scrollbar from appearing on all code snippets 657 658 ## v0.13.1 659 660 * Enhancements 661 * Autolink Elixir's stdlib modules and functions 662 * Show callbacks in search results 663 * Reduce size taken by font-sizes 664 * Increase size for headings in the moduledoc 665 666 * Bug fixes 667 * Fix opened sidebar on small screens 668 * Allow horizontal scrolling for code snippets on small screens 669 670 ## v0.13.0 671 672 * Bug fixes 673 * Fix issue where docs would fail when being built on Erlang 19 674 * Store templates in `priv` rather than in `lib` 675 676 * Backwards incompatible changes 677 * Require Elixir ~> v1.2 678 679 ## v0.12.0 680 681 * Enhancements 682 * Remove warnings when running on Elixir v1.3 683 * Support for `@optional_callbacks` 684 * Improve styling for nested lists 685 * Include earmark as a default dependency 686 687 * Bug fixes 688 * Fix many styling and performance front-end related bugs 689 690 ## v0.11.5 691 692 * Enhancements 693 * Support canonical URLs 694 695 * Bug fixes 696 * Autolink now allows digits in function names 697 * Sort specs by line to preserve ordering 698 * Focus on content element on document ready 699 * Remove ligature fix on Firefox and Safari as Google Fonts have been updated 700 701 ## v0.11.4 702 703 * Bug fixes 704 * Fix ligature issues in recent browsers 705 * HTML escape headers 706 * Avoid warning on Elixir master (v1.3) 707 708 ## v0.11.3 709 710 * Bug fixes 711 * Fix a regression where the sidebar wouldn't stick on small screens 712 713 ## v0.11.2 714 715 * Enhancements 716 * Include night mode for docs 717 * Take advantage of extra space on large screens by widening sidebar 718 719 * Bug fixes 720 * Do not attempt to retrieve docs from Erlang modules 721 722 ## v0.11.1 723 724 * Bug fixes 725 * Include callbacks even if a module defines a struct 726 727 ## v0.11.0 728 729 * Enhancements 730 * From now on it's possible to set the title in the sidebar area for 731 additional content, *default:* "Pages" 732 * Set the path and title of each additional page in `mix.exs` file 733 * Use the first `h1` as menu title if title is not configured 734 * Include the project name as part of the header in small devices 735 736 * Bug fixes 737 * Increase the visual separation between functions 738 * Remove the `extra-` prefix for the additional documentation files 739 * Extra large images do not create an overflow in the content 740 741 ## v0.10.0 742 743 * Enhancements 744 * Many improvements and bug fixes in new layout 745 * Reduced build size 746 * Overview has been renamed to API Reference 747 * All extra content, including API Reference, has been moved to inside 748 "Pages" 749 * Extra files are now downcased and prefixed by `extra-` 750 751 ## v0.9.0 752 753 * Enhancements 754 * Whole new clean, readable, usable, responsive layout 755 * Support for adding logo to generated docs (must be 64x64 pixels) 756 * Support for adding extra pages to generated docs 757 * Improve formatting of typespecs and callbacks 758 759 * Backwards incompatible changes 760 * `--readme` option and `:readme` configuration have been removed. Use 761 `:extras` in your `mix.exs` file or pass `--extra` / `-e` in the 762 command-line (may be given multiple times) 763 764 ## v0.8.4 765 766 * Bug fixes 767 * Generate `README.html` file instead of `readme.html` as in previous 768 releases 769 * Style fixes in the new layout 770 771 ## v0.8.3 772 773 * Bug fixes 774 * Style fixes in the new layout 775 776 ## v0.8.2 777 778 * Enhancements 779 * Uglify and minify JS and CSS code 780 * Performance improvements when building sidebar 781 * Redirect from index.html to proper page 782 783 * Bug fixes 784 * Style fixes in the new layout 785 786 ## v0.8.1 787 788 * Bug fixes 789 * Style fixes in the new layout 790 791 ## v0.8.0 792 793 * Enhancements 794 * New and responsive layout without frames 795 796 ## v0.7.3 797 798 * Bug fixes 799 * Update [highlight.js][] with fixes some inlining issues 800 * Require latest [Earmark][] 801 802 ## v0.7.2 803 804 * Bug fixes 805 * Support Elixir master 806 * Fix error reporting when modules are compiled without docs 807 808 ## v0.7.1 809 810 * Enhancements 811 * Use `type=search` for search input 812 * Update [highlight.js][] dependency 813 * Properly tag code comments as coming from Elixir/IEx unless noted otherwise 814 * Add support for hash redirection 815 816 ## v0.7.0 817 818 * Enhancements 819 * Documentation is now generated at `doc` to follow OTP "standard" 820 821 ## v0.6.2 822 823 * Enhancements 824 * Improvements to the document structure 825 * Add syntax highlight 826 827 ## v0.6.1 828 829 * Enhancements 830 * Autolink modules and functions in the README 831 * Generate ids for callbacks starting with "c:" 832 * Ensure group ordering is consistent: TYPES > FUNCTIONS > MACROS > CALLBACKS 833 * Allow users to search by Module.function 834 835 ## v0.6.0 836 837 * Enhancements 838 * Support Elixir v1.0.0-rc1 839 840 ## v0.5.2 841 842 * Bug fixes 843 * Use proper ANSI escape sequence on Mix success messages 844 845 ## v0.5.1 846 847 * Enhancements 848 * Support Elixir v0.15.0 849 * Add support for [Earmark][] - no need for external processors 850 851 ## v0.5.0 852 853 * Enhancements 854 * First public release 855 * Support [pandoc][] and [devinus/markdown][markdown] as markdown processors 856 857 [pandoc]: http://pandoc.org/ 858 [markdown]: https://github.com/devinus/markdown 859 [earmark]: https://github.com/pragdave/earmark 860 [highlight.js]: https://highlightjs.org/