-
Enhancements
- Support cheatsheets as
.cheatmd
files
- Support cheatsheets as
-
Bug fix
- Collapse sidebar when resizing page even if stored in the session as opened
-
Enhancements
- Add Elixir special punctuation ! and ? to natural sort
- Add night mode to settings pane
- Support --proglang in mix docs
- Save sidebar state per session
- Distinguish output code blocks in Livebooks
-
Bug fixes
- Prevent sidebar button scrolling out of view
- Prevent unreadable text when using inline code with admonition headers
-
Enhancements
- Do not preserve spaces from spec declaration in signature rendering
- Index hyphens in search
- Index
@
in search - Change minimal package search length to 2
-
Bug fixes
- Remove extra
term()
argument at start of@macrocallback
- Remove extra
-
Enhancements
- Add a toast when changing theme via keyboard
- Automatically convert
.livemd
links to.html
ones - Show programming language in HTML footer
-
Bug fixes
- Properly escape
%/2
special form - Improve ranking of exact-matching modules in search
- Properly escape
-
Enhacements
- Include page titles in autocomplete suggestions
- Allow theme to be set to "System" version
- Remove "Specs" heading and render full typespecs
- Support for
source_url_pattern
in config being a function
-
Bug fixes
- Adjustments for blockquotes and admonition blocks in dark mode
- Fix module sorting when a list of dirs is provided
- Consider casing of letters when sorting items in the menu, summary, function list, etc
- Bug fixes
- Fix links and code tags in admonition text blocks for dark mode
-
Enhancements
- Add support for admonition text blocks
- Improve accessibility for light and dark themes
-
Bug fixes
- Ensure that
mix docs --open
works on Windows - Ensure search tokenizer also splits on underscore
- Fix false warnings about missing types when running ExDoc in escript mode
- Don't navigate when clicking the current page
- Ensure that
ExDoc v0.28.0 requires Elixir v1.11 .
-
Enhancements
- Use custom scrollbar in the sidebar
- Keep hamburger absolute to the opened sidebar
- Support
--open
flag onmix docs
- The copy button now only copies selectable content
-
Bug fixes
- Make sure filename configuration in
:extras
is used across links - Ensure all
extras
pages have a title generated - Fix margin on 3rd level headers and beyond
- Ensure a task that defines callbacks is still listed as a task
- Make sure filename configuration in
- Bug fixes
- Make HexDocs search case insensitive
- Improve sidebar open/close animation
- Bug fixes
- Fix version dropdown when hosted on HexDocs
- Fix tooltips
- Fix JavaScript error when Hex package information is not available
- Bug fixes
- Several usability fixes on the new layout
- Keep page ordering
- Enhancements
- Introduce new sidebar design
- Add
--quiet
option to CLI - Support multiple formatters in the CLI
- Show structs as
%Struct{}
instead of__struct__
in the sidebar - Point Erlang links to
www.erlang.org
instead oferlang.org
- Improvements to the night mode and styling
-
Backwards incompatible changes
:filter_prefix
has been renamed to:filter_modules
and supports anonymous functions:source_ref
now defaults to"main"
- Dropped support for smartypants in Markdown
-
Bug fixes
- Do not warn on links to sections
-
Enhancements
- Add copy button to code snippets
- Add
translate="no"
to the relevant attributes to improve interoperability with automatic translation tools - Support optional module annotations
- Introduce a settings modal to group most of configuration
- Allow customizing the Livebook expansion URL
- Provide documentation on how to render plugins such as Katex, VegaLite, and Mermaid
- Bug fixes
- Do not duplicate API Reference title
- Update assets for Livebook badge functionality
-
Enhancements
- Add source link to pages in
:extras
- Add "Run in Livebook" badge to
.livemd
pages in:extras
- Add source link to pages in
-
Bug fixes
- Do not generate entries for private Erlang functions
- Do not trim
?
and!
from Elixir tokens on search
-
Incompatible changes
- Remove unused
:source_root
option
- Remove unused
-
Enhancements
- Track user preference for sidebar state
-
Bug fixes
- Do not double escape page titles on the sidebar
- Do not fail when documenting cover compiled modules
- Don't crash upon doc chunks for unknown beam languages
- Enhancements
- Add support for Livebook's
.livemd
Markdown files - Preload all applications starting with
makeup_
before doc generation - Add Hex package config and display "Find on Hex" footer links
- Add support for Livebook's
-
Enhancements
- Supporting grouping of callbacks
- Use shell lexer for code blocks with no language and starting with
$
-
Bug fixes
- Fix generating type signatures with maps
- Skip Erlang modules that have empty docs
- Skip Erlang functions that have empty docs
- Fix accidentally showing shape of opaque types
-
Enhancements
- Handle remote types when generating signatures, e.g.
@callback callback1(GenServer.options())
becomescallback1(options)
- Support Markdown processor options
- Add
--paths
command line argument to prepend directories to the code path when generating docs - Make shell prompt,
$
, not selectable forshell
,sh
,bash
andzsh
code blocks
- Handle remote types when generating signatures, e.g.
-
Bug fixes
- Fix custom links to undefined/hidden references
- Fix generating external links with
:deps
configuration - Add ellipsis to more sections
-
Backwards incompatible changes
- Remove function landing pages
-
Enhancements
- Support stepped range syntax
-
Bug fixes
- Add spaces on paragraph endings for search results
- Fix bug defining app name in config
- Fix rendering void elements (
<br>
etc)
- Bug fixes
- Fix generating function landing pages
-
Enhancements
- Drop jQuery and refactor JavaScript codebase
- Remove highlight.js in favour of migration to Makeup
- Change autolink to return both path and hash for the current module
- Add next/previous at the end of extra pages
- Improve search input blur handling
- Update erlang.org/man URL
- Add function landing page
-
Bug fixes
- Ignore extensions when generating external links
- Fix autolink to handle URIs with arbitrary scheme part without warning
- Fix undefined reference warning for typespecs
- Fix search click behavior when a suggestion refers the current page
- Don't crash when we can't format spec
- Fix HTML escaping
Requires Elixir v1.10.
-
Enhancements
- Improve warnings on broken references
- Support Elixir v1.12-dev
-
Bug fixes
- Respect deps config in autolink
- Fix html escaping in the sidebar entries
- Fix retrieving specs for macros with
when
- Raise if none of :name or :app are found in mix.exs
- Don't crash on code blocks like "A.b.C"
- Bug fixes
- Properly fix CSS bug on headings
- Add expansion arrow to sections on sidebar
- Bug fixes
- Fix CSS bug on headings
- Enhancements
- Improve accessibility and add aria labels
- Show different title and message for a empty search value
- Bug fixes
- [HTML EPUB] Remove overlapping functions from defaults
- [HTML] Don't show tooltip for module sections and non-html files
- [HTML] Make sure tooltips work with escape ids.
-
Enhancements
- [HTML EPUB] Add support for path dependent markdown autolink (
feeddc1
) - [HTML EPUB] Improve auto-linking to callbacks and types (
12c0a01
) - [HTML EPUB] Replace
<kbd>
with<kbd><kbd>
when it represents keys to be hit (bd2b8df
) - [HTML] Hide sidebar-over-content on click/tap outside it (
b050775
) - [HTML] Redirect to correct file when changing version (
0f6f24b
) - [mix docs] Allow files with no extension in extra files (
26b93b6
) - [mix docs] Link to siblings in an umbrella (
b0d6fdd
) - [mix docs] Switch to
earmark_parser
. Runmix deps.unlock --unused
to remove the now unusedearmark
dependency. (021c772
)
- [HTML EPUB] Add support for path dependent markdown autolink (
-
Bug fixes
- [HTML EPUB] Bring back auto-linking to Kernel and Kernel.SpecialForms (
fa174eb
) - [HTML EPUB] Escape HTML special characters in signature (
5fed479
) - [HTML EPUB] Fix auto-linking
./2
and../2
(2e40acb
) - [HTML EPUB] Fix list of basic types to auto-link (
6df4a3b
) - [HTML EPUB] Make HTML valid (
1187ace
) - [HTML] Escape HTML special characters in sidebar (
d26ca71
) - [HTML] Fix keyboard shortcuts on non US keyboard layouts (
829c4ee
) - [HTML] Fix text overflow in sidebar (
a4ff547
) - [HTML] Handle snake case terms in search results (
d511d55
) - [mix docs] Don't crash on markdown that triggers warning (
e7cb79c
)
- [HTML EPUB] Bring back auto-linking to Kernel and Kernel.SpecialForms (
- Bug fixes
- [mix docs] Depend on earmark
~> 1.4.0
- [mix docs] Don't crash on comments in markdown
- [mix docs] Don't crash on HTML in markdown
- [mix docs] Depend on earmark
-
Enhancements
- [EPUB] Add epub to the default formatters
- [HTML EPUB] Move specs out of signature
- [HTML EPUB] Auto-link "erlang" types & callbacks
- [HTML EPUB] Auto-link "erlang" modules in custom links
- [mix docs] Warn on broken references in dependencies (e.g.
`String.upcase/9`
) - [escript] Add
--app
- [HTML EPUB] Auto-link to extras (e.g.
[foo](foo.md)
) - [mix docs] Undefined references warning now includes the filename
- [mix docs]
:skip_undefined_reference_warnings_on
now also accepts a filename - [HTML EPUB] Display moduledoc headings in the sidebar
-
Bug fixes
- [HTML] Fix hidden text selection, hide tooltips for details link
- [HTML EPUB] Fix function name sorting (group operators together)
- [HTML EPUB] Fix displaying nested modules
-
Backwards incompatible changes
- [mix docs] Remove built-in support for cmark markdown processor
- [mix docs] Replace
ExDoc.Markdown.to_html/2
withto_ast/2
- [HTML EPUB] Remove auto-linking for local calls to Kernel & Kernel.SpecialForms,
use fully qualified calls instead. (e.g. replace
`==/2`
with`Kernel.==/2`
.) - [mix docs]
:skip_undefined_reference_warnings_on
no longer accepts extras id, use extras filename instead.
-
Enhancements
- [HTML] Make "Exceptions" a module sub-grouping instead of a top-level group
- [HTML] Automatically group deprecated modules
- [HTML] Rely on
prefers-color-scheme
w/o night mode set - [HTML] Boost title on search results, add fun/arity to title
- [mix docs] Initial work on support for multiple languages
-
Bug fixes
- [HTML] Many improvements to the search engine
- [mix docs] Link to callback docs instead of copying them
-
Enhancements
- [HTML] Add hardcoded packages to the quick-switch search results
- [HTML] Filter out packages without docs on HexDocs in quick-switch
- [HTML EPUB] Support autolinking for multiple arities
- [mix docs] Avoid deprecation warnings on more recent earmark versions
- [mix docs] Warn on unavailable local functions
- [mix docs] Make invalid index redirect warning case-sensitive
- [mix docs] Ignore non-Elixir modules when missing chunk
-
Bug fixes
- [HTML EPUB] Do not create a custom link when destination does not exist
- [EPUB] Hide screen reader elements
- Bug fixes
- [HTML] Make sure package selector can be reopened after closed with
ESC
- [HTML] Ensure tooltip pages can be cached
- [HTML] Support large version numbers on the version dropdown
- [mix docs] Raise nice exception for missing ExDoc.Config
- [HTML] Make sure package selector can be reopened after closed with
-
Enhancements
- [HTML] Add support for reference popovers
- [HTML] Provide a "g" shortcut to Go To a Hexdocs package (with autocomplete)
- [HTML] Detect if browser prefers night mode
- [EPUB] Add support for covers and the authors field
-
Bug fixes
- [HTML EPUB] Ensure that link headers generate unique IDs
- [HTML EPUB] Sort structs fields so field names are always ordered
- [HTML EPUB] Do not strip "Elixir." prefix from module names
- [HTML] Support URLs with non-HTML safe characters
- [EPUB] Fix table of contents without groups
-
Enhancements
- Add "mix " prefix to Mix tasks
-
Bug fixes
- Improve scrolling on Safari
- Prevent text casing of codes
- Do not remove stop words from search and make sure function names are searchable in isolation
- Reduce the size of the search metadata
- Remove outline on focus and keep width in version dropdown
- Do not fail if we can't persist index
- Bug fixes
- Hide the spinner when no term is searched
- Use
?
for the shortcut hint text - Improve style of the version dropdown
-
Enhancements
- Rework the search bar to provide autocompletion
- Provide full-text search
- Automatically generate documentation for
defdelegate
definitions (requires Elixir v1.8 ) - Provide keyboard shortcuts (press
?
to see all available outputs) or click the link at the bottom of the page - Add support for versions dropdown to the HTML sidebar. This requires adding a
docs_config.js
(also configurable) that sets aversionNodes
JavaScript variable. - Improve mouseover titles on sidebar navigation
-
Bug fixes
- Do not hide structs in type/callback summary signatures
- No longer require double click to open up a sidebar on Mobile Safari
- Keep trailing periods in summaries
- Fix typespec
arg
number to start from 1 instead of 0
-
Enhancements
- Include a "goto" link on mouseover for expandable menu items
-
Bug fixes
- Always expand menu items, even if has a single child
- Fix sidebar bottom margin on Firefox
- Fix anchor links sometimes not working by moving JS to HTML head
- Unify code styling for makeup and hljs
- Do not replace the content of custom links pointing to Elixir modules
- Remove border-left on deprecated to not mistake it with a heading
-
Enhancements
- Allow logo in SVG extension
- Allow functions to be grouped based on metadata
- Allow api-reference.html page to be disabled
- Allow nesting of modules by prefix
- Autolink
mix help TASK
- Warn on undefined remote functions from project's docs
-
Bug fixes
- Sort function names alphabetically in the sidebar
- Fix search input color
- Disable earmark smartypants option
- Enhancements
- Update CSS styles
- Remove sourcemaps from package
This release requires Elixir v1.7 and later. For earlier Elixir versions, use ExDoc ~> 0.18.0.
-
Enhancements
- Do not select "iex>" when selecting code samples
- Use makeup to perform ELixir's syntax highlighting (other languages still use highlight.js)
- Use
[rel="noopener"]
on external links - Link directly to page if sidebar item has no subitems
- Autolink Kernel and Kernel functions and special forms with shorthands (for example, only
is_atom/1
is necessary) - Trim EEx contents to reduce HTML size
- Allow apps to be excluded from umbrella app docs
-
Bug fixes
- Exclude types with
@typedoc false
from the docs - Make sure autolink considers the longest matching dependency name in case of shared prefixes
- Exclude types with
- Bug fix
- Fix formatting of typespecs causing errors
- Update jQuery
- Properly remove underscore from typespec links
- Enhancements
- Improve documentation pages for printing
- Autolink Kernel, Kernel.SpecialForms, and built-in types
- Annotate opaque types
- Add vertical-align:top to tables
- Allow module-function-arity references in links
- Remove underscore from view source link
- Run code formatter on typespecs (if one is available)
- Make night mode switch link more obvious
- Bug fixes
- Include missing formatter files
-
Enhancements
- No longer strip empty parens from types
- Provide more extension point for markdown processors
- Remove assets from priv since they are now embedded at compile time
-
Backwards incompatible changes
- Remove built-in support for hoedown markdown processor
- 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)
- Bug fixes
- Fix broken search caused by outdated JavaScript files
-
Enhancements
- Allow modules to be grouped on the sidebar with the
:groups_for_modules
option - Allow extras to be grouped on the sidebar with the
:groups_for_extras
option
- Allow modules to be grouped on the sidebar with the
-
Backwards incompatible changes
- The previous
:group
option that could be specified for each entry in:extras
is no longer supported - 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
- The previous
-
Enhancements
- Generate favicon link if a logo is available
-
Bug fixes
- Do not version epub filename as the doc directory is likely already versioned
-
Enhancements
- Make sure its own search.html page and provide history
- Generate source maps only if the
--debug
flag is given - Users can now add custom HTML before the closing head tag and the closing body tag
- Highlight the target function/macro/type/callback when clicked
-
Bug fixes
- Remove extra
term()
argument at start of macro spec - Add unencoded link target for functions with special chars to cope with different behaviour in browsers
- Remove extra
- Enhancements
- Link
<h3>
headers as well - Add border to code tag
- Link
- Bug fixes
- Fix sidebar on mobile devices
- Bug fixes
- Fix hover icons coloring
-
Enhancements
- Separate tasks into "Mix Tasks" in sidebar
- Add types to the search results
- Improve accessibility
-
Bug fixes
- Strip nesting HTML tags in h2 headers
- Remove the old search results after every new search attempt
- Bug fixes
- Improve project name wrapping on HTML
- Properly set link in types with parameter
- Fix ExDoc.CLI.main/2 to keep --source-ref on Elixir v1.4
- Do not fail if localStorage is not available
-
Enhancements
- Closing the search takes you to where you were in the previous page
- Handle
__struct__/0
by displaying the struct instead - Warn when redirecting to a non-existent file
- List both functions and macros under "Functions"
- Automatically detect GitLab source URL patterns
-
Bug fixes
- Break long specs into lines
- Fix the initial state of the sidebar hamburger
- Do not error when abstract code is missing
- Properly link to erlang lib dirs
-
Backwards incompatible changes
- No longer support Pandoc
- Require Earmark 1.1
- Enhancements
- Allow ExDoc to work as an escript
- Enhancements
- Point to Elixir docs on hexdocs.pm
- Many improvements to layout and styling of EPUB formatter
- Support multiple formatters to be configured on
mix.exs
- Also digest
sidebar_items.js
- Force parentheses on type signature to remove ambiguity
- Generate top-level docs for an umbrella project
- Searching on mobile closes menu when the Enter key is hit
-
Enhancements
- Support the
:assets
option that automatically copies all entries in the given directory todoc/assets
- Remove numbering on Extras subheaders from sidebar
- Pass file and line information to markdown formatters for better warnings
- Allow extra pages to be grouped together under a given heading
- Generate ids for default name/arity pairs so they can be linked (both remotely and locally)
- Support the
-
Bug fixes
- Fix autolink for functions containing
%
,{
,}
or uppercase characters in the name
- Fix autolink for functions containing
-
Enhancements
- Automatically generate documentations links to any of your dependencies (by default links to hexdocs.pm but allows the URL to be configured)
- Allow documentation to be generated to Erlang modules
-
Bug fixes
- Make sure "Top" is not included twice on pages
- Bug fixes
- Include "Top" link in pages with no headings
- Include "Top" link in modules with no docs
-
Enhancements
- Add support for the epub formatter
- Support extraction from
<h2>
headers out of the settext format
-
Layout changes
- Indent documentation inside the function/macro/type/callback header
- Style types the same way as function/macro/callback and include a link to the source
- Increase font-sizes in the sidebar and code snippets
- Move the specs definition inside the function/macro/type/callback header and make better use of vertical space
- Use a gradient on the sidebar to avoid sudden cut-off when scrolling the modules list
- Fix the use of the back-button in some browsers
- Allow the whole sidebar to be navigated without moving away from the current page. Expand ( ) and collapse (-) buttons have been added to aid exploration
- Numerically order pages/guides headers
- Bug fixes
- Avoid scrollbar from appearing on all code snippets
-
Enhancements
- Autolink Elixir's stdlib modules and functions
- Show callbacks in search results
- Reduce size taken by font-sizes
- Increase size for headings in the moduledoc
-
Bug fixes
- Fix opened sidebar on small screens
- Allow horizontal scrolling for code snippets on small screens
-
Bug fixes
- Fix issue where docs would fail when being built on Erlang 19
- Store templates in
priv
rather than inlib
-
Backwards incompatible changes
- Require Elixir ~> v1.2
-
Enhancements
- Remove warnings when running on Elixir v1.3
- Support for
@optional_callbacks
- Improve styling for nested lists
- Include earmark as a default dependency
-
Bug fixes
- Fix many styling and performance front-end related bugs
-
Enhancements
- Support canonical URLs
-
Bug fixes
- Autolink now allows digits in function names
- Sort specs by line to preserve ordering
- Focus on content element on document ready
- Remove ligature fix on Firefox and Safari as Google Fonts have been updated
- Bug fixes
- Fix ligature issues in recent browsers
- HTML escape headers
- Avoid warning on Elixir master (v1.3)
- Bug fixes
- Fix a regression where the sidebar wouldn't stick on small screens
-
Enhancements
- Include night mode for docs
- Take advantage of extra space on large screens by widening sidebar
-
Bug fixes
- Do not attempt to retrieve docs from Erlang modules
- Bug fixes
- Include callbacks even if a module defines a struct
-
Enhancements
- From now on it's possible to set the title in the sidebar area for additional content, default: "Pages"
- Set the path and title of each additional page in
mix.exs
file - Use the first
h1
as menu title if title is not configured - Include the project name as part of the header in small devices
-
Bug fixes
- Increase the visual separation between functions
- Remove the
extra-
prefix for the additional documentation files - Extra large images do not create an overflow in the content
- Enhancements
- Many improvements and bug fixes in new layout
- Reduced build size
- Overview has been renamed to API Reference
- All extra content, including API Reference, has been moved to inside "Pages"
- Extra files are now downcased and prefixed by
extra-
-
Enhancements
- Whole new clean, readable, usable, responsive layout
- Support for adding logo to generated docs (must be 64x64 pixels)
- Support for adding extra pages to generated docs
- Improve formatting of typespecs and callbacks
-
Backwards incompatible changes
--readme
option and:readme
configuration have been removed. Use:extras
in yourmix.exs
file or pass--extra
/-e
in the command-line (may be given multiple times)
- Bug fixes
- Generate
README.html
file instead ofreadme.html
as in previous releases - Style fixes in the new layout
- Generate
- Bug fixes
- Style fixes in the new layout
-
Enhancements
- Uglify and minify JS and CSS code
- Performance improvements when building sidebar
- Redirect from index.html to proper page
-
Bug fixes
- Style fixes in the new layout
- Bug fixes
- Style fixes in the new layout
- Enhancements
- New and responsive layout without frames
- Bug fixes
- Update highlight.js with fixes some inlining issues
- Require latest Earmark
- Bug fixes
- Support Elixir master
- Fix error reporting when modules are compiled without docs
- Enhancements
- Use
type=search
for search input - Update highlight.js dependency
- Properly tag code comments as coming from Elixir/IEx unless noted otherwise
- Add support for hash redirection
- Use
- Enhancements
- Documentation is now generated at
doc
to follow OTP "standard"
- Documentation is now generated at
- Enhancements
- Improvements to the document structure
- Add syntax highlight
- Enhancements
- Autolink modules and functions in the README
- Generate ids for callbacks starting with "c:"
- Ensure group ordering is consistent: TYPES > FUNCTIONS > MACROS > CALLBACKS
- Allow users to search by Module.function
- Enhancements
- Support Elixir v1.0.0-rc1
- Bug fixes
- Use proper ANSI escape sequence on Mix success messages
- Enhancements
- Support Elixir v0.15.0
- Add support for Earmark - no need for external processors
- Enhancements
- First public release
- Support pandoc and devinus/markdown as markdown processors